JAVA编码规范V1-0.doc

软通动力公司 JAVA编程规范 编号：ISS-STD-JAVA 版本:1.0 变更记录 日期 版本 变更说明 作者 2012－6－26 在软通编码规范基础上修改 李博宇、包维、李强、张本晨、沙丽沄 2012－07－12 在软通编码规范基础上修改 李博宇、包维、李强、张本晨、沙丽沄 2012－07－13 在软通编码规范基础上修改 李博宇、包维、李强、张本晨、沙丽沄 目录 1 导言 5 1.1 目的 5 1.2 范围 5 1.3 角色和职责 5 1.4 术语定义 5 2 格 式 6 2.1 .缩进 6 2.2间隔 7 2.3空行 8 2.4类成员的摆放顺序 8 2.5文件格式(File Format) 8 2.6行最大长度 9 2.7括号 9 3 命名规则 10 3.1 类和接口 10 3.2 包 10 3.3 get和set方法（属性的定义） 10 3.4 变量 11 3.4.1 普通变量： 11 3.4.2 常用对象变量 11 3.4.3 Static Final变量的命名 11 3.4.4 临时变量 11 4 注 释 12 4.1 要求 12 4.2 JavaDoc说明 12 4.3 类 13 4.4 方法 14 4.5 代码的自我说明 15 5 编 码 16 5.1 不要使用的结构 16 5.1.1 “do…while” 16 5.1.2 return (建议，尽量避免，也可以使用) 16 5.1.3 continue 16 5.1.4 break 16 5.2 不要混合使用递增运算符和递减运算符 16 5.3 变量初始化 17 5.4 魔鬼数字/字符 17 5.5 范围（scope） 17 导言 Java语言给了程序员充分的空间随意编写自己的代码，但也正是因为如此，一个程序员自己编写的代码往往不能被别的程序员很好的阅读和理解。 目的 本文档旨在提供一个编码的标准，以便所有Java代码在产生的一开始就能够在整个开发团队中保持一致，从而能够更好的阅读和修改代码。 范围 本文档适用于软通动力公司项目开发团队的所有成员，为了使项目的后期维护和修改变的容易，在每个项目开发中一定要遵守本文档中的规定术语定义 角色和职责 编码负责人： 本规范在具体项目中执行监督负责人。通过实施Source Review 制度，编程人员在完成自己的一个模块并提交测试前，由编码负责人进行Source Review，不符合本编程规约的程序一律打回，重新修改，即编码人你认为自己的程序没有任何的功能问题。 编码人员 本规范的遵守者。 术语定义 Logger - 系统进行日志输出了类，为引用第三方（Apache Group）的输出类，具体用法见 Log输出规范的说明。 格 式 .缩进 所有的缩进皆为4个空格。对应的括号通常在同一列的位置上。例如： void foo() { while ( bar 0 ) { Logger.debug(); bar-- ; } if ( oatmeal == tasty ) { Logger.debug(Oatmeal is good and good for you); } else if ( oatmeal == yak ) { Logger.debug(Oatmeal tastes like sawdust); } else { Logger.debug(tell me pleeze what iz dis oatmeal); } switch( suckFactor ) { case 1: Logger.debug(This sucks); break; case 2: Logger.debug(This really sucks); break; default: Logger.debug(whatever); break; } } 1）．所有的缩进是由Space(空格)键形成的，而不是Tab键。 2）．所有的if、while和for语句中的状态内容必须用括号括起来，就算只有一个状态。 if ( superHero == theTick ) { Logger.debug(Spoon!); } 2.2间隔 1）．所有的标识符都必须被空白字符包围。 int theTick =