Jav代码规的范学习指导.docVIP

Java代码规范 前言： 为提高软件开发的质量和速度、增强代码的可读性、统一编程人员在实际工作中的代码编写风格，特此制定出本团队的代码规范，希望各位同仁认真阅读、严格遵守本规范。 规范等级说明 级别I:?? 默认级别，要求所有项目中的所有成员遵守。 级别II: ?建议所有项目中的所有成员遵守。 级别III: 鼓励各个项目根据实际情况执行。 1.格式与命名规范(Formating and Naming Conventions) 1.1??缩进 使用Tab缩进，而不是空格键--将缩进2，4，8字符的选择权留给阅读者。 1.2 换行 每行120字符--因为已是1024*768的年代。 if,for,while语句只有单句时，如果该句可能引起阅读混淆，需要用 {和}括起来，否则可以省略。 //错误，需要使用花括号{}括起来if (condition)if(condition) doSomething();elsedoSomething(); 1.3?命名规则 不允许使用汉语拼音命名? 遇到缩写如XML时，仅首字母大写，即loadXmlDocument()而不是loadXMLDocument() Package名必须全部小写，尽量使用单个单词 为了基于接口编程，不采用首字母为I或加上IF后缀的命名方式，如IBookDao,BookDaoIF。 页面部件名建议命名为：btnOK、lblName或okBtn、nameLbl。( II )其中btn、lbl缩写代表按钮(Button)、标签(Label)。 局部变量及输入参数不要与类成员变量同名(get/set方法与构造函数除外) 方法的名字的第1个单词应以小写字母开头，后面的单词则建议用大写字母开头。 常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则建议用下划线来分割这些单词 1.4 声明 修饰符应该按照如下顺序排列：public, protected, private, abstract, static, final, transient, volatile, synchronized, native, strictfp。 类与接口的声明顺序(可用Eclipse的source-sort members功能自动排列):? 静态成员变量 / Static Fields 静态初始化块 / Static Initializers 成员变量 / Fields 初始化块 / Initializers 构造器 / Constructors 静态成员方法 / Static Methods 成员方法 / Methods 重载自Object的方法如toString(), hashCode() 和main方法 类型(内部类) / Types(Inner Classes) 同等的类型，按public, protected, private的顺序排列。 2.注释规范(Document Convertions) 2.1 注释的格式 注释中的第一个句子要以（英文）句号、问号或者感叹号结束。Javadoc生成工具会将注释中的第一个句子放在方法汇总表和索引中。 为了在JavaDoc和IDE中能快速链接跳转到相关联的类与方法，尽量多的使用@see xxx.MyClass，@see xx.MyClass#find(String)。 Class必须以@author 作者名声明作者，不需要声明@version与@date，由版本管理系统保留此信息。( II ) 2.?注释的内容 可精简的注释内容 注释中的每一个单词都要有其不可缺少的意义，注释里不写@param name -名字这样的废话。 如果该注释是废话，连同标签删掉它，而不是自动生成一堆空的标签，如空的@param name，空的@return。 推荐的注释内容 对于已知的Bug需要声明。( II ) 在本函数中抛出的unchecked exception尽量用@throws说明。( II ) Null规约 如果方法允许Null作为参数，或者允许返回值为Null，必须在JavaDoc中说明。 如果没有说明，方法的调用者不允许使用Null作为参数，并认为返回值是Null Safe的。 /**?* 获取对象.?*?* @ return the object to found or null if not found.?*/Object get(Integer id){...} 特殊代码注释 代码质量不好但能正常运行，或者还没有实现的代码用//TODO: 或 //XXX:声明? 存在错误隐患的代码用//FIXME:声明 3.编程规范(Programming Conv