[DD–4.2]程规范(JAVA).docVIP

编程规范（JAVA） (V1.0) 文档编号: DD–4.2 生效日期: 2010.05.01 修订记录 日期 修订版本 描述 作者 2010.4.7 V1.0 建立初始版本 刘宇 编程规范 1. 规范的规范 本文档描述有如下默认定义： 本规范的每一条目必须无二义性，并且可执行。否则作废本规范的条目分为两个级别uggestions-建议 本规范所有的“规则”条目必须被遵守所有的标示符都只能用ASC字母（A-Z或a-z）、数字（0-9）和下划线“_” 者英文单词(credit.treeutil)。 所有类命名使用名词组合(如: UserManager)。命名类和接口时，将所有单词的首字母大写。方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。例如：etInstName()。变量名第一个字母小写，任何中间单词的首字母大写。变量名应简短且可以顾名思义，易于记忆。常量的声明应该全部大写，每个单词之间用“_”连接final String VERSION_NOW=”1.0”)。 抽象类使用 Abstract 作为类名的前缀，而接口建议使用 Interface作为接口名后缀异常类应该使用 Exception 做为名称后缀缺省接口实现应该使用Default名称前缀也可以采用 Impl 作为后缀i，j，k 等，提高编程效率。 使用 get/set 对类属性进行访问。 使用 is 前缀表示一个布尔变量和方法。 在查询方法中应使用 find 作为前缀。 使用 initialize 做为对象初始化的方法前缀，也可以简写为init。 对于对象集合， 变量名称应使用复数。 避免使用否定布尔变量(如：bool isError; // 避免: isNoError)。 对于单例类（Singleton），应该使用getInstance 方法得到单例。 如： class UnitManager { private final static UnitManager umInst = new UnitManager(); private UnitManager() { ... } public static UnitManager getInstance(){ return instance_; } } 对于工厂类，进行创建对象的方法，应该使用 new 前缀。 class PointFactory { public Point newPoint(...) { ... } } 3.注释规范 3.1注释规范-R类条目 代码必须和注释保持同步。 注释使用中文。如果注释中有超过一个段落，用 P 标签 分隔示例代码以 PRE/PRE 包裹注释中的第一个句子要以句号、问号或者感叹号结束。实现注释和文档注释实现注释用以注释代码或者实现细节。文档注释从实现自 由(implementation-free) 的角度描述代码的规范与通用的块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line) 上端注释第一个上端注释 String word = “”; // 第二个上端注释 有多种通用注释方式，推荐上端注释，与代码，使程序便于 下端注释if (1 == a) { // 这是第一个下端注释} else { // 这是第二个下端注释} 若是条件组合级的注释则推荐下端注释，即阐述满足条件后的动作 组合added by wulin新增传值:业务合同号“contno”,”111111”); // end 修改程序的备注，用于改动了的程序或功能后记录，需要用上端注释与下端注释修改内容时间、、added/edited/shielded)、原因/* * 这是一个块注释*/ 单行注释： if (condition) { /* 这里是一个单行注释. */ ... } 尾端注释： if (2 == a) { return TRUE; /* 尾端注释 */ } else { return isPrime(a); /*尾端注释*/ } 行末注释： if (foo 1) { // 行末注释 ... } else { return false; //行末注释} //if (bar 1) { // // //行末注释// //} //else { // return false; //} 方法注释建议采用以下格式： 该方法是做什么的。该方法如何工作。?代码修改历史纪录。?