Java开发规范.doc

Java开发规范
版本

作者
孙桂玉/张光磊
修订历史
第1章绪论 3
目的 3
范围 3
第2章代码组织与风格 3
基本原则 3
缩进 3
长度 3
行宽 4
间隔 4
对齐 4
括号 4
第3章注释 4
基本原则 4
JavaDoc 4
文件与包注释 5
类、接口注释 5
方法注释 6
第4章命名 6
基本原则 6
界面控件命名原则 7
第5章声明 7
第1章绪论
目的
本规范的目的是使项目组能以标准的、规范的方式设计和编码。通过建立编码规范,以使每个开发人员养成良好的编码风格和习惯;并以此形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性和一致性等,增进团队间的交流,并保证软件产品的质量。
范围
本规范适用于“Topway”及其下所有软件项目、产品等的设计、开发以及维护、升级等。
本规范使用于“Topway”的所有软件开发人员,在整个软件开发过程中必须遵循此规范。
第2章代码组织与风格
基本原则
代码的组织和风格的基本原则是:便于自己的开发,易于与他人的交流。
因个人习惯和编辑器等可以设置和形成自己的风格,但必须前后一致,并符合本规范的基本要求和原则。
缩进
子功能块当在其父功能块后缩进。
代码中以TAB(4个字符)缩进,在编辑器中请将TAB设置为以空格替代,否则在不同编辑器或设置下会导致TAB长度不等而影响整个程序代码的格式。例如:

public void methodName(){
if(some condition){
for(…){
//some sentences
}//end for
}//end if
}
长度
单个函数的有效代码长度当尽量控制在100行以内(不包括注释行)
建议单个类的长度包括注释行不超过1500行。
页宽
建议页宽应该设置为80字符。
间隔
类、方法及功能块间等应以空行相隔,但不得有无规则的大片空行。
建议操作符两端应当各空一个字符以增加可读性。
对齐
关系密切的行应对齐
括号
{} 中的语句应该单独作为一行,左括号"{"当紧跟其语句后,右括号"}"永远单独作为一行且与其匹配行对齐,建议在其后说明其匹配的功能模块。
左括号是否换行等随个人习惯而定,若换行则当与其前导语句首字符对齐。
第3章注释
基本原则
不要为注释而注释。
JavaDoc
对类、方法、变量等的注释需要符合JavaDoc规范,对每个类、方法都应详细说明其功能、条件、参数等,并使用良好的HTML标记格式化注释,以使生成的JavaDoc易阅读和理解。
类注释中当包含版本和作者信息,使用SVN标记自动跟踪版本变化和修改记录
文件与包注释
在每个文件、包的头部都应该包含该文件的功能、作用、作者、版权以及创建、修改记录等。
文件注释模板如下,每个研发人员必须设置该模板:
/* ======================================