JAVA编码规范(1.0)….docVIP

JAVA编码规范 神州泰岳 2013年6月7日 版本记录： 文件状态： [√] 草稿 [ ] 正式发布 [ ] 正在修改 当前版本： 1.0 作 者： 完成日期： 签 收 人： 签收日期： Java编码规范 1 1. 说明 8 2. 命名规范 8 2.1. Package的命名规范 8 2.2. Class命名规范 9 2.3. Method命名规范 11 2.4. 变量命名规范 12 3. 注释规范 13 3.1. 变更履历注释规范 14 3.2. 类头注释规范 14 3.3. 成员注释规范 16 3.4. 方法注释规范 17 3.5. 代码修改注释规范 18 4. 排版规范 18 4.1. 详细规范内容 18 5. 语句规范 21 5.1. 控制语句风格规范 21 5.2. 命令语句风格规范 23 5.3. 声明语句风格规范 26 6. 设计规范 27 6.1. 复杂度控制规范 27 6.2. Class设计规范 28 6.3. Method设计规范 29 6.4. 变量设计规范 31 7. 常用类规范 32 7.1. Object整体规范 32 7.2. 修饰符规范 33 7.3. 字符串规范 35 7.4. 数值规范 37 7.5. 集合规范 37 7.6. Stream规范 38 7.7. 例外规范 39 7.8. 线程规范 40 8. 日志规范 42 8.1. 详细规范内容 42 说明 本文对规定了Java编程的规范，主要包括命名、注释、排版、语句、设计、常用类以及日志规范。统一规范的格式有利于项目的交付和后续维护。 本文档适用于所有以Java为开发语言的定制开发应用系统。 命名规范 命名规范使程序易读，从而更易于理解。Java的一般规则。 例如： Package名要有意义 尽量给Package命名一个能联想到Package内容的名字。如果使用功能ID、流水号等来命名Package的话，不能马上明白其意思。遵守此规范，将提高代码的易读性。 Package名不应缩写 即使Package名长，也请尽量不要缩写，而使用易懂的名字。 例如： Package名的组成 标准的package名分为三部分：公司名.应用系统名.模块名，本公司公司名均使用com.citicpru。 例如： Class命名规范 Class的名称应该是一个名词短语 Class的名称应是“形容词/名词+名词”的形式。 例如： Class名要能体现其作用 Class名中，请不要使用功能ID、流水号等难懂的名字。Class名要使用有意义的字符串，以便能联想到其Class的内容。这样将提高代码的易读性。 例如： Class名中单词的第1个字母要大写 请大写Class名的第1个字母。当Class名由多个单词组成时，每个单词的第1个字母（段落）都要大写,其余字母小写。这是Java的一般规则。 例如： 例外Class名的最后要加上“Exception” 对例外Exception”。统一此写法，将提高代码的易读性。 例如： Interface名要基于Class名 Interface的命名规则基本上要基于Class名。统一此写法，将提高代码的易读性。I”。 例如： 抽象Class名要基于Class名 抽象Class名的命名规则基本上要基于Class名。统一此写法，将提高代码的易读性。Abstract”开始，再加上能联想到Subclass名的名字。 例如： 实体Class名要基于Interface名 实体Class名的命名规则基本上要基于Interface名。统一此写法，将提高代码的易读性。Impl”。 例如： 在能力附加型的Interface名后面加上“able” 对于Class来说，会存在附加某能力的Interface，如Runnable, Cloneable等。定义能力附加型的Interface时，请使用能表示其能力的形容词(～able）统一此写法，将提高代码的易读性。 Method命名规范 Method名只在段落时采用大写字 关于Method名，只有一个单词时，全部采用小写字。当由多个单词组成时，第2个以后的单词的第1个字母要大写。这是Java的一般规则。 生成Object的create+Object名”的create”开始，并在其之后加上此Method生成的Object名。统一此写法，将提高代码的易读性。 转换Method名的格式是“to+Object名 关于将Object转换成其他Object的Method（Converter Method），以“to”开始，并在其之后加上转换后的Object的名字。统一此写法，将提高代码的易读性。 Getter Method名的格式是“get+属性名 关于取得属性的Method（Getter