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

北京用友软件股份有限公司 银行产品开发部 Java编程规范 作者： 共 NUMPAGES 9页 第 PAGE 9页 ※客户化开发组※ Java编程规范 作者： 评审： 批准： 发布日期：2012/2/13 当前版本：V0.1  修订历史纪录 *A – 追加 M – 修改 D – 删除 版本改版日期改版说明*作者评审批准V0.12012/2/13A创建刘振目 录  TOC \o 1-3 \h \z \u  HYPERLINK \l _Toc241551808 修订历史纪录  PAGEREF _Toc241551808 \h 2  HYPERLINK \l _Toc241551809 1 Java编程规范  PAGEREF _Toc241551809 \h 4  HYPERLINK \l _Toc241551810 1.1 代码书写风格  PAGEREF _Toc241551810 \h 4  HYPERLINK \l _Toc241551811 1.2 注释书写风格  PAGEREF _Toc241551811 \h 4  HYPERLINK \l _Toc241551812 1.2.1 类注释  PAGEREF _Toc241551812 \h 5  HYPERLINK \l _Toc241551813 1.2.2 接口注释  PAGEREF _Toc241551813 \h 5  HYPERLINK \l _Toc241551814 1.2.3 函数注释  PAGEREF _Toc241551814 \h 5  HYPERLINK \l _Toc241551815 1.2.4 类属性注释  PAGEREF _Toc241551815 \h 6  HYPERLINK \l _Toc241551816 1.2.5 局部变量注释  PAGEREF _Toc241551816 \h 6  HYPERLINK \l _Toc241551817 2 附录  PAGEREF _Toc241551817 \h 6  HYPERLINK \l _Toc241551818 2.1 命名字典  PAGEREF _Toc241551818 \h 6  HYPERLINK \l _Toc241551819 2.1.1 动词表  PAGEREF _Toc241551819 \h 7  HYPERLINK \l _Toc241551820 2.1.2 专业名词  PAGEREF _Toc241551820 \h 7  HYPERLINK \l _Toc241551821 2.2 匈牙利命名法前缀表  PAGEREF _Toc241551821 \h 7   Java编程规范 代码书写风格 必须给程序加注释。注释能够极大提高代码的质量。 代码的书写必须清晰、易读。 适当的将代码分段可以使代码更加清楚。可以使用‘{’‘}’将函数分成若干个小的单元； 适当的加入空行可以使代码更加清晰。例如在函数的定义后面加入两个空行，在两个逻辑小代码单元间加入一个空行； 建议遵循三十秒原则。如果另一个程序员无法在三十秒之内了解你的函数做了什么，如何做以及为什么要这样做，那就说明你的代码是难于维护的，必须得到提高； 在一个函数内代码的长度不允许超过200行。建议如果一个函数的代码长度超过一个屏幕，那么或许这个函数太长了。 一行代码尽量简短，并且保证一行代码只做一件事。那种看似技巧性的冗长代码只会增加代码维护的难度。保证不必左右拉动滚动条来阅读一整行代码，将会使你的代码更加可读，这一点包括注释； 使用圆括号来界定操作的顺序。不要让别人判断复杂的操作优先级。 使用统一的格式化代码。将‘{’放在所有者的后面，并且在下一行代码前加入TAB键4格缩进；（TAB键比用若干个空格更容易控制使用统一的缩进距离） if(XXX){ while(XXX){ xxx xxx } } 注释书写风格 注释应该用中文清晰表达意思。应该能够使程序看起来更清晰，更容易理解。 注释要尽量简明，避免装饰性的、标语式的注释。 另起一行的注释，要写