Java~命名规范

下面总结以点java命名规范

虽然感受这些规范比起C#来讲有点怪,但仍是应该尊重它的命名!java

命名规范

  1. 项目名所有小写
  2. 包名所有小写
  3. 类名首字母大写,若是类名由多个单词组成,每一个单词的首字母都要大写。
  4. 变量名、方法名首字母小写,若是名称由多个单词组成,每一个单词的首字母都要大写。
  5. 常量名所有大写
  6. 全部命名规则必须遵循如下规则:
    . 名称只能由字母、数字、下划线、$符号组成
    . 不能以数字开头
    . 名称不能使用JAVA中的关键字。
    . 坚定不容许出现中文及拼音命名。

注释规范

1 类注释

在每一个类前面必须加上类注释,注释模板以下:code

/**
* 类的详细说明
*
* @author 类建立者姓名
* @Date    建立日期
*   @version 1.00
*/
2 属性注释

在每一个属性前面必须加上属性注释,注释模板以下:it

/** 提示信息 */
private String strMsg = null;
3 方法注释

在每一个方法前面必须加上方法注释,注释模板以下:io

/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明今后类方法中抛出异常的说明
*/
4 构造方法注释

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

/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明今后类方法中抛出异常的说明
*/
5 方法内部注释

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

//背景颜色
int init =1;

待续...变量

相关文章
相关标签/搜索