文件名称:Java代码书写规范
文件大小:77KB
文件格式:DOC
更新时间:2015-08-16 11:27:34
Java代码 书写 规范
Java代码书写规范 1 符号命名规则 符号名包括:模块名,变量名,常量名,方法(函数/子程序)名,数据区名,缓冲区名等。符号命名通常应遵循以下规则: 1.1 通用规则 (1)在所有命名中,都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写,除非该名字描述的是中文特有的内容,如半角、全角, 声母、韵母等。 (2)所有命名都应遵循达意原则,即名称应含义清晰、明确。 (3)所有命名都不易过长,应控制在规定的最大长度以内。 (4)所有命名都应尽量使用全称。 (5)如果命名使用缩写,则必须对其进行注释和说明。 1.2 具体规范 目录 1 符号命名规则 1 1.1 通用规则 1 1.2 具体规范 1 2 代码书写规范 2 3 程序的注释规范 7 3.1 原则 7 3.2 文档注释的一般格式 7 3.3 注释的检查工具 8 3.4 描述部分 8 3.5 标记惯例 9 3.6 程序异常的注释 10 3.7 包级的注释 10 3.8 内部类的注释 11 3.9 注释样例 12