端抛出的 * 异常则在 getUserMsg() 中携带应在界面上显示的信息串 * * @since 2001-12-18 * @author lijun * @version 1.0 * */
3.3.2
过程和方法约定注释与 JavaDoc 中对应:
Method Comments Parameter Comments Returns 如有改动,自己添加 如有改动,自己添加
功能描述: 参数说明: 返回值说明: 最后更新作者: 最后更新日期:
/** * 初始化方法,在这里初始化所有用户公用的变量, * 这里简单地将
工作交给父类处理。 * @param config ServletConfig 对象,包含 Servlet 初始化的参数。 * @throws ServletException 初始化可能产生 ServletException 异常。 * @return */
命名: 4. 命名:
一般概念: 4.1 一般概念: 命名时应始终采用完整的英文描述符。此外,一般应采用小写字母,但类名、接口名以及任何非初始单词的第一个 字母要大写。 尽量使用完整的英文描述符,采用适用于该领域的术语 采用大小写混合使名字可读 尽量少用缩写,但如果用了,要明智地使用。 避免使用长的名字(小于 15 个字母是个好主意) 避免使用类似的名字,或者仅仅是大小写不同的名字 作为补充,在一个项目中需要有相关的术语表(Glossary Glossary)对命名进行规范,特别是在使用拼音缩写时,需要有 Glossary 术语表的定义。
类型标识符( Tag) 4.2 类型标识符(Type Tag) 说明:类型标识符(Type Tag)由一个字母序列组成;类型标识符经过约定唯一标识一种数据类型。包括以下各种 约定: 数据类型 byte short int long char float double boolean String java.util.Date,java.
sql.Date ja
va.sql.Timestamp java.util.Vector java.util.List Java.util.Map Arrays of
类型标识符 Byte Short i l ch f d b s dt ts v lst mp a +
为逐一直接列出的请参照下面的例子: int: iXxxx long: lXxxx String array: asXxxx 类名( Name): 4.3 类名(Class Name):
4.3.1
规则 -
ClassName::= Word(((‘_’)Word)*) Word::= [A-Z]([a-z]*)
4.3.2
说明 -
类名(ClassName)由一个或多个词汇(Word)组成;词汇可以是英文单词或汉语拼音缩写(须注明意义),首字 母大写; 词汇间可以用下划线 ‘_’ 分割, 也可不用, 一般的规律是: 如果各词汇多由英文组成则不需用下划线 ‘_’ , 反之若各词汇多由汉语拼音缩写组成则需用。如果是接口则在最前加大写‘I’。
4.3.3
例如:
ConfigEnv BookstoreManager 接口:IBookstoreManager
4.4 方法名(Method Name): 方法名( Name)
4.4.1 4.4.2
规则 说明 -
MethodName::= word((Word)*)
方法名 (MethodName) 由一个或多个词汇 (word/Word) 组成; 词汇可以是英文单词或汉语拼音缩写 (须注明意义) , 第一个词汇首字母小写,其他词汇首字母大写;词汇间不可用下划线‘_’分割。
4.4.3
例如
add() addItem() updateNsxmmWithServerData() 变量名( Name) 4.5 变量名(Variable Name):
4.5.1 4.5.2
规则 说明 -
VariableName::= word((Word)*)
变量名(Variable Name)由一个或多个词汇(word/Word)组成;词汇可以是英文单词或汉语拼音缩写(须注明意 义),第一个词汇首字母小写,其他词汇首字母大写;词汇间一般不用下划线‘_’分割(除下面给出的特例); 第一个词汇可为类型标识符(详见下面关于类型标识符的说明)以表明该变量的类型,如果第一个词汇不是类型标 识符,则该变量的类型应是显而易见的,或不言自明的,或另有文档说明且已明示所有可能的编码人员;为方便生 成 get/set 的方法,成员变量不使用类型标识符,直接使用名称。
4.5.3
例如
Int iIndex String sTemp 成员变量: String nsrbm Integer nsxmCount String nsr 常量名( Name) 4.6 常量名(Constant Name)
4.6.1
规则 -
ConstantName::= WORD(‘_’(WORD)*) WORD::= [A-Z]([A-Z]*)
4.6.2
说明 -
常量是带有 final 限定字的特殊的类成员变量