JAVA编码规范

看到国内某公司的编码规范,总结了一下:
1.顺序:变更履历
Package声明
Import声明
Class Header
Class
常量(Menifest Variables)
成员变量(Instance Variables)
初始Block(initializer Blocks)
构造器(Constructors)
属性(Properties)
方法(Public Method)
方法(Protected Methods)
方法(Private Methods)
内部类(Inner Class)
测试方法(Test Main)

2.标准的package名可以分为三部分:<公司名>.<应用程序名>.<包名>;全部为小写字母

3.“Class Header”可以分为3部分——说明部分、版本信息和其他信息,中间使用NULL行分割。
 程序中的每一个类都必须有Class注释。根据需要,Class注释中除了说明部分不能省略外,版本信息和其他信息都可以省略。
 Class注释中的说明部分的写法参考范例,根据需要,可以省略其中的一些说明部分(可省略的部分后标有可选)。

4.Class的名称应该是一个名词短语。 可以是“形容词/名词 + 名词”的形式。 例如InputDataStream、Developer、OrderItem等。Class的名称由1个或1个以上的英语句单词组成, 其中每一个英语句单词的首字母应该大写, 其余字母小写。

5.类成员变量的名称使用26个英文字母并且规定使用下划线“_”开头。

6.如果缺省构造器中没有任何代码,则应使用“//null”标注
public MyClass() { //正确
//null
}

7.在方法内部的注释要写明Why,而不是What

8.当Class名由多个单词组成时,每个单词的第1个字母(段落)都要大写;例外Class名的最后要加上“Exception”;Interface的命名规则基本上要基于Class名。统一此写法,将提高代码的易读性。如果需要与Class名区分,请在开头加上“I”。

9.关于Method名,只有一个单词时,全部采用小写字。当由多个单词组成时,第2个以后的单词的第1个字母要大写;生成Object的Method名的格式是“"create"+Object名”;
转换Method名的格式是“"to"+Object名”
Getter Method名的格式是“"get"+属性名”
Setter Method名的格式是“"set"+属性名”
boolean 通过返回变量的Method名要能看出true/false的状态

10.变量命名:
通过boolean变量要能看出true/false的状态;
常量全部为static final、全部是大写字、段落用“_”
变量名要反映其作用
Instance变量名的格式是“"_"+变量名”
Instance的字段名全部使用大写字

11.控制语句规范:
关于for语句的循环计数器,各嵌套分别使用"I"、"j"、"k"…等
控制语句(if, else, while, for, do while)的“{ }”是不可省略的
在利用了for语句的重复处理中,不更改循环变量的值
for语句的计数从0开始
使用break及continue将变得难懂
不要在循环内生成对象

12.命令语句风格规范
return语句不使用括号
boolean变量已比较完毕
不等号要向左("<"、"<=")
不轻易重复使用Local变量
在单一Method中不能使用4次以上否定运算符“!”
表示long型的常量时,使用“L”而不是“I”
不使用嵌套的赋值

13.声明语句风格规范
1个Statement中有1个变量声明
数组声明形式为“型名[]”
变量声明要有初始值

14.书写格式规范
不使用Tab,而且使用空白字符
缩进量是4个空白字符
避免过长的行
在"{"之后不写Statement
在逗号之后输入空白字符
在赋值运算符(=, +=, -=, …)前后输入空白字符
在for语句内的分号之后输入空白字符
在“++”及“--”和运算数之间不输入空白字符
在Bit运算符("|"、"&"、"^"、"<<"、">>")的前后输入空白字符
在逻辑运算符("||"、"&&")的前后输入空白字符
在关系运算符("<"、">"、">="、"<="、"=="、"!= ")的前后输入空白字符
在算术运算符("+"、"-"、"*"、"/"、"%")的前后输入空白字符
在条件运算符“?”的前后分别输入1个空白字符
最后写main()
禁止使用System.out.println输出(为了控制系统中的日志输出,原则上禁止使用System.out.println输出。调试阶段的System.out.println输出在发布时应该注释掉)


确实,规范的编码容易阅读,容易进行维护,也很美观,不过这些多的细节还得在以后的编码过程中慢慢的养成……

你可能感兴趣的:(JAVA基础)