Java的命名规范详解

1 命名规范

1.1 Package 的命名
package 的名字应该都是由一个小写单词组成。在开头为相对应的域名的名称，其后跟相应 的名字。
1.2 Class 的命名
Class 的名字施行驼峰标识，即如果由多个单词组成则 每个单词的第一个字母必须大写，中间不能有任何非字母字符。测试类的命名，必须冠以后缀 Test，比如SomeClassTest。
1.3 Interface 的命名
Interface 的命名同Class 的命名规则，但必须冠以前缀I ,比如ISomeInterface，接口的实现 类则是去掉前缀I但添加后缀Impl，比如SomeInterfaceImpl。
1.4 Class 变量的命名（Object 的命名）
变量的名字施行驼峰标识，即如果由多个单词组成则每个单词的第一个字母必须大写，中间不能有任何非字母字符。意义不是太明确或不是太常用单词组成成员变量必须生成 JavaDoc 注释文档。
/**

• 用户账号
  **/
  1.5 static final 变量的命名
  static final 变量的名字应该都大写，并指出完整含义。如：SYSTEM_NAME。
  1.6 参数的命名
  参数的名字必须和变量的命名规范一致。
  1.7 数组的命名
  数组的命名必必须和变量的命名规范一致。需要注意的一点是数组的声明必须如下：
  String[] buffer; 而不应该是： String buffer[];
  1.8 方法的命名
  方法命名通常以动词打头，第一单词的首字母小写，后面的单词以大写字母开头。方法的 命名尽可能指出这个方法的功能是干什么的。测试类的测试方法命名必须以 test 打头，比如 testSendMessage(…)。
  1.9 构造函数
  构造函数它应该用递增的方式书写（参数多的写在后面）。。
  1.10 {}括号
  第一个大括号不能单独起一行，终止大括号与方法声明的第一个字母对齐。
  public String getUsername() {

return username;
}

1.11 注释
注解注释以”/”开头，以”/”结束，javadoc识别的注释则需要以”/”开 头，以”*/”结束,具体的解释用//。
1.12 类与方法注释格式
类注释
/

• • 客户信息
• @Written by : zhanghongxin
• @Creation Date : Jul 29, 2011 11:31:17 AM
• @version : v1.00
• @Description :
• @ModificationHistory Who When What -------- ----------

•                  ------------------------------------------------
  

•                  zhanghongxin Jul 29, 201111:31:17 AM TODO
  

**
/
方法注释
/*
* @Written by : zhanghongxin
* @Creation Date : Jul 29, 2011 7:02:45 PM
* @version : v1.00
* @Description : 跳转客户信息新建页面*
* @param req
* @return
*
*/
千锋教育整理，侵联系删除，来源网络，仅供参考