关于java项目的规则

命名规则

1.项目的命名必须小写,不能是中文
2.包的命名一般是以:com.公司.项目.模块

3.类的命名(若是单个字母)头字母必须大写;(若是多个单词),则每个单词的首字母都要大写

4.变量和方法的命名第一个单词应以小写字母作为开头,后面的单词则用大写字母开头
如:public void toString(){ }

5.常量名一般为大写
如:public static final String GAME_COLOR=”RED”;

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

注释的规则

1.类的注释

在每个类前面必须加上类注释,注释模板如下
/**

  • 类的描述
  • @author 作者
  • Date 创建日期
  • @version 1.00
    */

2.属性的描述

在每个属性前面必须加上属性注释,注释模板如下:
/** 提示信息 */

private String strMsg = null;

3.方法的描述

在每个方法前面必须加上方法注释,注释模板如下:
/**

  • 类方法的详细使用说明
  • @param 参数1 参数1的使用说明
  • @return 返回结果的说明
  • @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
    */

4.构造方法的描述

在每个构造方法前面必须加上注释,注释模板如下:
/**

  • 构造方法的详细使用说明
  • @param 参数1 参数1的使用说明
  • @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

5.方法内部的注释

在方法内部使用单行或者多行注释,该注释根据实际情况添加。

如://背景颜色

   Color bgColor = Color.RED

猜你喜欢

转载自blog.csdn.net/qq_43718048/article/details/84187932