java项目定名规范
java项目命名规范?规范等级说明级别I:?? 默认登记要求所有项目中的所有成员遵守。级别II: ?建议所有项目中
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();
else
????doSomething();1.3?命名规则?- 遇到缩写如XML时，仅首字母大写，即loadXmlDocument()而不是loadXMLDocument()
- Package名必须全部小写，尽量使用单个单词
- Interface名可以是一个名词或形容词(加上'able','ible', or 'er'后缀)，如Runnable，Accessible。
为了基于接口编程，不采用首字母为I或加上IF后缀的命名方式，如IBookDao,BookDaoIF。 - 局部变量及输入参数不要与类成员变量同名(get/set方法与构造函数除外)
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
- 类型(内部类) / Types(Inner Classes)
???? 同等的类型，按public, protected, private的顺序排列。
2.注释规范(Document Convertions)
2.1 注释类型
2.1.1 JavaDoc注释
? 略。
2.1.2 失效代码注释
? 由/*...*/界定，标准的C-Style的注释。专用于注释已失效的代码。
/*
?*?Comment?out?the?code
?*?String?s?=?"hello";
?*?System.out.println(s);
?*/?2.1.3 代码细节注释
? 由//界定，专用于注释代码细节，即使有多行注释也仍然使用//，以便与用/**/注释的失效代码分开
? 除了私有变量外，不推荐使用行末注释。
class?MyClass?{
????private?int?myField;?//?An?end-line?comment.
????public?void?myMethod?{
???????//a?very?very?long
???????//comment.
???????if?(condition1)?{
??????????//condition1?comment
??????????...
????????}?else?{
??????????//elses?condition?comment
??????????...
????????}
????}
}?2.2?注释的格式
?与?的代码校验已经可以查出很多的代码质量问题。再配合使用，，三重检查，涵盖了大部分的代码GuideLine。