JAVA代码开发规范.pdfVIP

JAVA 代码开发规范 V3.0 一．开发工具规范： 1. 开发工具经项目负责人调试后统一确定。 2. 开发工具一经确定不允许集成任何非统一插件，若有需要，经项目负责人同意后统一为 项目组成员添加。 3. 开发工具的编码格式不允许修改。 二．排版规范： 1. 关键词 （或变量）和操作符之间加一个空格。 例如：int iCont = 1；//操作符和值之间有一个空格。 2. 相对独立的代码块与块之间加空行。 例如：两个方法之间需要用空格隔开。 3. 较长的语句、表达式等要分成多行书写。 4. 长表达式要在低优先级操作符处划分新行，操作符放在新行之首。 5. 代码的新行与上一行根据逻辑关系要进行适应的缩进 （一个table 键），使排版整齐，语 句易读。 6. 不允许把多个短语句写在一行中，即一行只写一条语句。 7. 函数或过程的 始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。采用 TABLE 键缩进。 8. 循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。 9． 若函数或过程中的参数较长，则要进行适当的划分。 10. 用大括号‘{’和 ‘}’界定一段程序块时，编写程序块时‘{’和 ‘}’应各独占一行 并且位于同一列，同时与引用它们的语句左对齐。在函数体的 始、类的定义、结构的定义、 枚举的定义以及if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方 式。 JAVA代码开发规范(WISHSOFT) 11. main 方法:如果main(String[]) 方法已经定义了, 那么它应该写在类的底部. 三．命名规范： 1. Package(包)的命名 Package 的名字应该都是由一个小写单词组成。 例如：package com.wish； 2. Class 的命名 Class 的名字必须由大写字母 头而其他字母都小写的单词组成,对于所有标识符，其 中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。 例如： public class DatabaseOperator { } 3. Class 中成员变量的命名 变量的名字必须用一个小写字母 ，后面的单词用大写字母 ，不需要数据类型前 缀。 例如：userName,size。 4. Class 中Static Final 变量的命名 static Final 变量的名字应该都大写，并且指出完整含义。 例如： public static final String DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig; 5. Class 中方法的命名 方法的名字 的单词必须用一个小写字母，后面的单词用大写字母 。 例如：setName() , getMethod()。 6. 方法声明中参数命名 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字。 例如： public void setCounter(int size) { JAVA代码开发规范(WISHSOFT) this.size = size; } 7. 方法内变量的命名 Class 中成员变量的命名。 8. 数组的命名 数组应该总是用下面的方式来命名： byte[] buffer;而不是： byte buffer[]； 9. 分页中每页列表数量的变量使用pageSize，当前的所在的页号为pageNumber 。 四．注释规范： 1. 注释要简单明了。 2. 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。 3. 在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二 义性。保持注释与其描述的代码相邻，即注释的就近原则。 4. 变量、常量的注释应放在其上方相邻位置或右方，不可放在下面。 5. 全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存 取时注意事项等的说明。