客户化开发_Java编程规范规范讲述.doc

※客户化开发组※ Java编程规范 作者： 评审： 批准： 发布日期：2012/2/13 当前版本：V0.1  修订历史纪录 *A – 追加 M – 修改 D – 删除 版本 改版日期 改版说明* 作者 评审 批准 V0.1 2012/2/13 A 创建 刘振 目 录 修订历史纪录 2 1 Java编程规范 4 1.1 代码书写风格 4 1.2 注释书写风格 4 1.2.1 类注释 5 1.2.2 接口注释 5 1.2.3 函数注释 5 1.2.4 类属性注释 6 1.2.5 局部变量注释 6 2 附录 6 2.1 命名字典 6 2.1.1 动词表 7 2.1.2 专业名词 7 2.2 匈牙利命名法前缀表 7  Java编程规范 代码书写风格 必须给程序加注释。注释能够极大提高代码的质量。 代码的书写必须清晰、易读。 适当的将代码分段可以使代码更加清楚。可以使用‘{’‘}’将函数分成若干个小的单元； 适当的加入空行可以使代码更加清晰。例如在函数的定义后面加入两个空行，在两个逻辑小代码单元间加入一个空行； 建议遵循三十秒原则。如果另一个程序员无法在三十秒之内了解你的函数做了什么，如何做以及为什么要这样做，那就说明你的代码是难于维护的，必须得到提高； 在一个函数内代码的长度不允许超过200行。建议如果一个函数的代码长度超过一个屏幕，那么或许这个函数太长了。 一行代码尽量简短，并且保证一行代码只做一件事。那种看似技巧性的冗长代码只会增加代码维护的难度。保证不必左右拉动滚动条来阅读一整行代码，将会使你的代码更加可读，这一点包括注释； 使用圆括号来界定操作的顺序。不要让别人判断复杂的操作优先级。 使用统一的格式化代码。将‘{’放在所有者的后面，并且在下一行代码前加入TAB键4格缩进；（TAB键比用若干个空格更容易控制使用统一的缩进距离） if(XXX){ while(XXX){ xxx xxx } } 注释书写风格 注释应该用中文清晰表达意思。应该能够使程序看起来更清晰，更容易理解。 注释要尽量简明，避免装饰性的、标语式的注释。 另起一行的注释，要写在被注释程序的上一行。 类注释 类型的用途、目的。 格式： /** * 描述类的功能、用途、现存BUG等。 * 作者：XXX * @version 最后修改日期 * @see 需要参见的其它类 * @since 从产品的那一个版本，此类被添加进来。（可选） * @deprecated该类从产品的那一个版本后，已经被其它类替换。（可选） */ 如果对已经版本话的类进行了修改，需要按照如下格式为每一次修改附加修改历史记录： // 修改人 + 修改日期 // 修改说明 接口注释 接口的注释风格基本与类的注释风格相同。 格式：同类注释 函数注释 函数头注释必须包括：函数执行了什么功能；函数处理过程中对对象的那些属性可能进行更改；函数执行前后，对象的状态。 比较、循环等控制结构必须加注释； 局部变量必须加注释； 复杂难写的代码必须加注释； 如果一系列代码的前后执行顺序有要求，必须注释说明。 格式： /** * 描述函数的功能、用途、对属性的更改，以及函数执行前后对象的状态。 * @param 参数说明 * @return 返回值 * @exception 异常描述 * @see 需要参见的其它内容 * @since 从类的那一个版本，此方法被添加进来。（可选） * @deprecated 该方法从类的那一个版本后，已经被其它方法替换。（可选） */ 类属性注释 描述域的用途。 注释对变量的固定限制。例如 dayOfMonth 域就应该注明它的值在1-31之间。 必须理清，并且清楚的注明并发问题。并发错误是很难在调试和维护阶段发现和排除的； 局部变量注释 每行只声明一个局部变量，并且在行末加入注释； 注释的参考内容为说明该变量被什么、在那里、为什么使用； 附录 命名字典 根据系统功能的界定，补充表内容。 动词表 汉语含义 英文单词或缩写 范例 做某事 do doQuery 设置 set setName 取得 get getName 审核 check checkVoucher 增加 add addEmployee 修改 modify modifyContent 删除 delete,remove deleteWorkCenter 更新 update,refresh 查询 query, search, find 专业名词 汉语含义 英文单词或缩写 范例