java项目命名规范

一、命名规范

1、 项目名全部小写
eg : donews_bigdata

2、 包名全部小写
eg : com.donews.kafkatohbase

3、 类名首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写。
eg：public class MyFirstClass{}

4、 变量名、方法名首字母小写，如果名称由多个单词组成，则后面的单词则建议用大写字母开头。
eg：int index=0;
eg : String getKafkaList = “”
eg : public void calculate(){}
eg : public void kafkaToHbase(){}

5、 常量名全部大写
eg：public static final String GAME_COLOR=”RED”;

6、所有命名规则必须遵循以下规则：
1)、名称只能由字母、数字、下划线、$符号组成
2)、不能以数字开头
3)、名称不能使用JAVA中的关键字。
4)、坚决不允许出现中文及拼音命名。

二、注释规范

1、 类注释

在每个类前面必须加上类注释，注释模板如下：

/**
* FileName: KafkaToHbase.java
* 类的详细说明
*
* @author 类创建者姓名
* @Date 创建日期
* @version 1.0
*/

2、 属性注释

在每个属性前面必须加上属性注释，注释模板如下：
/* 提示信息 */
private String strMsg = null;

3、 方法注释

在每个方法前面必须加上方法注释，注释模板如下：
/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

4、 构造方法注释

在每个构造方法前面必须加上注释，注释模板如下：
/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

5、 方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。
eg：//背景颜色
Color bgColor = Color.RED

       如果您喜欢我写的博文，读后觉得收获很大，不妨小额赞助我一下，让我有动力继续写出高质量的博文，感谢您的赞赏！！！