2.命名规范.docx

开发命名规范
版本信息
* A代表新增，M代表修改，D代表删除。

2014-07-26
李健进
A
拟初稿

类，命名原则为每个英文单词的首字母为大写，其它的为小写，如：、、。
说明：对一些不同操作类型的类可以按操作类型进行命名，如：
Action类可命名为：模块名称+；
Dao类可命名为：模块名称+。
变量/属性/对象的命名原则
变量、字段、属性或对象的命名原则为第一个英文单词为小写，其它的首字母为大写，其它的为小写。只允许使用英文+数字的组合。如：firstName、zipCode、unitPrice、discountRate、orderItems
函数的命名原则
函数的命名应采用完整的英文描述符。原则如下：
大小写混合使用；
第一个英文单词为小写，其它的首字母为大写；
函数名称的第一个单词常常采用一个有强烈动作色彩的动词。
openAccount()、printMailingLabel()、createUser()、delete()
getter函数的命名原则
getter函数除布尔字段外，应采用get作为字段的前缀，布尔字段采用is或get作为前缀。如：getFirstName()、isAtEnd()
setter函数的命名原则
setter函数无论何种字段类型，都要在字段名的前面加上 set 前缀。如：setPersistent(boolean isPersistent) 、setAtEnd(boolean isAtEnd)
常量的命名原则
类常量的声明，应该全部大写，单词间可以用下划线隔开。如：static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999;
static final int GET_THE_CPU = 1;
Java注释规范
注释编写原则
注释总则：编写程序时，先注释后编码；修改代码时，也是先修改注释、再修改代码；
注释不仅列出相应代码的功能，而且还应给出如此编写代码的原因及思路；
注释以清晰、实用为目的，避免使用广告横幅那样的装饰性注释风格。
注释类型
Java 注释语句类型
Java 有三种注释语句风格：
以 /** 开始， */ 结束的文档注释；
以 /* 开始，以 */ 结束的C语言风格注释；
以及以 // 开始，代码行末尾结束的单行注释。
下表是对各类注释语句建议用法的一个概括，也给出了几个例子。
注释语句类型
用法
示例
文档注释
在接口、类、成员函数和字段声明之前紧靠它们的位置用文档注释进行说明。文档注释由 javadoc 处理，为一个类生成外部注释文档，如下所示。
/**
Customer （顾客）.顾客是指作为我们的服务及产品的销售对象的任何个人或组织。
***@author . Ambler
*/
C 语言风格注释
采用 C 语言风格的注释语句将无用的代码注释掉。
/*
保留这些代码是因为用户可能改变想法，或者只是想在调试中暂时不执行这些代码。
这部分代码已被它前面的代码替代，所以于 1999 年6 月 4 日被 B. Gustafsson 注释掉。如果两年之后仍未用这些代码，将其删除。
. . . （源代码）
*/
单行注释
在成员函数内部采用单行注释语句对业务逻辑、代码片段和临时变量声明进行说明。
// 因为让利活动
// 从 1995 年 2 月开始，
// 所以给所有超过 $1000 的
// 发货单 5% 的折扣。
javadoc标志
Sun 公司的 Java Development Kit (JDK) 中有一个名为 javadoc 的程序。它可以处理 Java 的源代码文件，并且为 Java 程序产生 HTML 文件形式的外部注释文档。Javadoc 支持一定数目的标记，标识注释文档中各段起始位置的保留字。详情请参考 JDK javadoc 文档。
标记
用于
目的
***@author name
类、 接口、源程序
说明特定某一段程序代码的作者。每一个作者各有一个标记。
***@deprecated
类、 成员函数
说明该类的应用程序编程接口 (API) 已被废弃，因此应不再使用。
***@exception name description或
***@throws exceptiondescription
成员函数
说