一、Java文件名与文件组织结构。
1、Java文件名由实意文件名+后缀组成,后缀名因类型的不同而不同。Java源文件的后缀是.java,Java字节码文件的后缀是.class。
2、一般来说,Java源文件的结构是,每一节代码之间是由一个空行分割开的,并且每一节都有相应的注释,通常情况下,Java源文件不应该超过2000行,否则,就视为类“臃肿”。
3、每一个Java源文件一般由下面的顺序构成。
(1)、文件注释头。
(2)、包名(package)。
(3)、引入(import)声明。
(4)、类(class)或接口(interface)的声明部分。
二、Java文件注释头。
1、Java类文件注释头是用来描述该类功能及其特点,以及相关开发信息的。例如,如下格式:
/** * 该类功能及其特点的描述(例如:该类是用来... ...)<br/> * * 该类未被编译测试过<br/> * * 开发公司或单位:能力有限公司<br/> * * 版权:能力有限研发中心<br/> * * @see (与该类相关联的类):(File.class)<br/> * * @author : 比尔-盖茨<br/> * * @since :Jdk1.6<br/> * * @version :v1.x-beta<br/> * * @date : 2011-11-11 11:11:11<br/> * * 最后更改日期 :2011-12-12 12:12:12<br/> * * 修改人:乔布斯<br/> * * 复审人:奥巴马 希拉里 克林顿<br/> * */
三、包的声明与引用。
1、包名应该是独一无二不可重复的。
2、包名通常情况下都应该是小写ASCII字母。
3、包名一般是公司域名的倒序,经常用到的域名有cn、com、edu、gov、mil、net、org。
4、域名之前的国家名称可以由一个到两个英文字母做前缀用来表示国家名称,这个规则可以参考ISO标准3166。
5、域名后面的部分可以根据习惯命名。
四、Java源文件编排格式。
1、一般编排格式中的行间缩进,是以四个空格键(space)为单位的。另,一个Tab键是8个空格。
2、代码行长度。一般来说,Java的代码行长度应该小于80个字符。
3、折行规则。
(1)、在逗号后折行。
(2)、在运算符(operator)前折行。
(3)、高层折行优于低层折行。
(4)、折下的代码行应与其同等级的代码行左对齐。
(5)、如果上面的法则令代码行右侧距页边的距离,差距较大并且混乱,我们可以在适当行采用Tab键处理。
五、空格与空行的应用规则。
1、空格的应用规则。
(1)、空格一般应用于关键字与括号之间。注意:方法名称与左括号之间不应该用空格分开。例如:while (true) {}
(2)、一般在参数列表中的逗号后面插入空格。例如:process(arg1, arg2, ... , argn)
(3)、数学算式的操作数与运算符之间应该添加空格。例如:X = xx>>3; a = (a + b) / (c * d)
(4)、for语句中的表达式应该用分号分隔开。例如:for(expr1; expr2; expr3)
(5)、强制类型转换语句中的强制类型的右括号与表达式之间应该用逗号隔开。例如:(byte) num
2、空行的应用规则。
(1)、在同一源文件的两个代码片段之间,或者在同一源文件的类与接口的定义之间可以插入两行空白行。
(2)、在如下情况中,需插入一行空白行。a).在两个方法之间。b).在方法内部的本地变量与第一个语句之间。c).在块注释与单行注释之前。d).在方法内部的逻辑片段之间。