Java编程规则.xls

规则号 规则内容 工具自动检查 规则1 1 1 源代码文件 java 的布局顺序是 包 import语句 注释 类 规则1 1 2 遵循统一的布局顺序来书写import语句 不同 类别的import语句之间用空行分隔 无用的 Import要删除 规则1 1 3 程序中一行的代码和注释不能超过150列 规则1 1 4 源程序中关系较为紧密的代码应尽可能相邻 增 加代码段分割标志 方便代码段的分割 整个注 释行不留空格 各种不同功能的代码放到相应的 代码段中 段落之间空行只要空一行 现在包括 的代码段包括 常量定义 变量定义 构造方法 公共方法 内部方法 界面事件响应方法 调 试方法等 一般的代码段顺序也应和上面一致 规则1 1 5 if else else if for while do等语句 独占一行 执行语句不得紧跟其后 不论执行语 句有多少都要加 规则1 2 1 一般禁止使用制表符 必须使用空格进行缩排 缩进为4个空格 规则1 3 1 不同逻辑程序块之间要使用空行分隔 规则1 3 2 一元操作符如 类型 等前后不加空格 这类 操作符前后不加空格 规则1 3 3 多元运算符和它们的操作数之间至少需要一个 空格 规则1 3 4 方法名之后不要留空格 规则1 3 5 向后紧跟 向前 紧跟 紧跟处不留空格 之后要留空格 不是行结束符号时其后要留空格 规则1 3 6 注释符与注释内容之间要用一个空格进行分隔 规则1 4 1 长表达式 超过120列 要在低优先级操作符 处拆分成新行 操作符放在新行之首 以便突出 操作符 拆分出的新行要进行适当的缩进 使 排版整齐 规则1 4 2 方法声明时 修饰符 类型与名称不允许分行 书写 规则2 1 注释使用中文注释 与doc有关的标准英文单词 标签保留 规则2 2 文件头部必须进行注释 规则2 3 公共方法前面应进行文档型注释 列出 函数的 目的 功能 输入参数 返回值等 规则2 4 保证代码和注释的一致性 修改代码的同时修改 相应的注释 不再有用的注释要删除 规则2 5 注释应与其描述的代码相近 对代码的注释应放 在其上方 需与其上面的代码用空行隔开 或右 方 对单条语句的注释 相邻位置 不可放在下 面 规则2 6 注释与所描述内容进行同样的缩进 规则3 1 遵循统一的规范来书写包的声明 必须以 com zte开头 规则3 2 Package 的名字应该都是由一个小写单词组成 规则3 3 类名采用大小写结合的方法 构成类名的每个单 词的首字母的首字母也必须大写 有特殊情况需 要说明 规则3 5 变量标识符只能由26个英文字母 10个数字及下 划线的一个子集来组成 并严格禁止使用连续的 下划线 必须用一个小写字母开头 后面的单词 用大写字母开头 用户定义的标识符下划线不能 出现在标识符的头尾 规则3 7 程序中不要出现仅靠大小写区分的相似的标识符 规则3 9 一般变量名不得取单个字符 如i j k等 作 为变量名 局部循环变量除外 规则3 11 避免直接使用数字常量 提高代码可读性 规则3 13 控件命名应采用完整的英文描述符命名 名字 的前缀是控件类型名 规则3 14 方法名应当能体现方法的作用 必须用小写字 母开头的单词组合而成 且应当使用 动词 或 者 动词 名词 动宾词组 规则3 15 获取性方法的命名有两类 一种是判断性的操 作 获取属性的状态 返回值为boolean 如 判断某些控件的状态等 对于这些操作 应当是 以is为方法声明的开头 另外一种是获取返回值 的操作 对一这种操作 应当以get开头 规则3 16 属性设置性的方法命名以set开头 后紧跟属性 名 规则3 17 参数的命名和变量的命名规范一致 使用有意 义的参数命名 对于对数据类的属性的Get和Set 方法用和要赋值的字段一样的名字 规则3 21 控件变量命名 按照规范 如控件的缩写 详 见 常用控件前缀缩写说明 变量首字母小写 等 规则4 1 一行只声明一个变量 规则5 1 每一行应该只包括一个语句 规则5 2 在表达式中使用括号 使表达式的运算顺序更清 晰 规则5 4 在switch语句中 每一个case分支必须使用 break结尾 最后一个分支必须是default分支 规则5 5 避免在 if 条件中赋值 规则5 7 条件语句中对于if判断中的boolean值变量 只 要直接判断就可以了 规则6 1 类内部的代码布局顺序 属性 构造函数 方法 备注 代表用checkstyle自动检查 代表人工检查的编程规则 备注 检查规则 集成环境设置成1