java程序编码规范

《java程序编码规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Java程序编码规范1、概述本规范主要针对“Java程序编码”，它在现有的一些编码规范基础上，作了一些修改和裁剪，供开发组执行。目的是保证开发组所编写的代码保持一贯的风格，提高代码编写的可读性，使用的一致性和后期的易维护性。2、书写规范2.1代码书写规范1、必须给程序加注释。注释能够极大提高代码的质量。2、代码的书写必须清晰、易读。适当的将代码分段可以使代码更加清楚。可以使用‘{’‘}’将函数分成若干个小的单元；适当的加入空行可以使代码更加清晰。例如在函数的定义后面加入两个空行，在两个逻辑小代码单元间加入一个空行；建议遵循三十秒原则。如果另一个程序员无法在三十秒之内了

2、解你的函数做了什么，如何做以及为什么要这样做，那就说明你的代码是难于维护的，必须得到提高；3、在一个函数内代码的长度不允许超过100行。建议如果一个函数的代码长度超过一个屏幕，那么或许这个函数太长了；4、一行代码尽量简短，并且保证一行代码只做一件事。那种看似技巧性的冗长代码只会增加代码维护的难度。5、使用圆括号来界定操作的顺序。不要让别人判断复杂的操作优先级。6、使用统一的格式化代码。类所包含方法体的’{‘将放在单独一行。方法体中将‘{’放在所有者的后面，并且在下一行代码前加入TAB键(两个字符)缩进；（TAB键比用若干个空格更容易控制使用统一的缩进距离）。例如，下面

3、的第1行是错误的，第2行是正确的：if(i>0){i++};//错误，{和}在同一行if(i>0){13i++};//正确”}”语句应该缩进到与其相对应的”{“相对齐的位置。1、保证不必左右拉动滚动条来阅读一整行代码，将会使你的代码更加可读，这一点包括注释；在任何情况下，超长的语句应该在一个逗号或者一个操作符后折行。一条语句折行后，应该比原来的语句再缩进2个字符。2、括号和后一个字符之间不应该出现空格，同样，右括号和前一个字符之间也不应该出现空格。下面的例子说明括号和空格的错误及正确使用：CallProc(Aparameter);//错误CallProc(Aparam

4、eter);//正确3、赋值语句（=）、逻辑操作符（<>!=

5、

6、&&等等）、算术操作符等左右各空一格10、公有成员放在程序的最前面、私有成员在后。2.2注释书写规范2.2.1注释总规则1、代码要求必须有注释，详细程度以其他人能够读懂为标准。注释应该用中文清晰表达意思。应该能够使程序看起来更清晰，更容易理解。如果某一段程序不值得写文档，那么可能它是无效的代码。2、注释要尽量简明，避免装饰性的、标语式的注释。3、注释不但要说明做什么，还应当说明为什么要这样做。最好先写注释表明要做什么，再进行编码。4、另起一行的注释，要写在被注释程序的上一行。5、自定义的全局变量必须有注释

7、，说明变量的含义；6、自定义的函数、过程必须有详细的注释，说明函数和过程的功能，同时说明输入输出接口、参数、返回值；7、实现步骤较多、较复杂的程序模块要有相应的注释，说明每个关键步骤的具体操作内容和实现步骤；131、复杂的算法程序要有注释，说明算法功能，解释算法实现过程。2.2.2注释类型下表说明Java注释的三种类型，并给出使用建议。注释类型用法示例文档注释在紧靠接口、类、成员函数和成员声明的前面注释它们。注释语句由javadoc处理，为一个类生成外部文档。/**客户：客户是我们将服务和产品卖给的人或机构。@authorS.W.Ambler*/C语言风格采用C语言风

8、格的注释去掉不再使用但你仍想保留的代码。仍想保留是因为用户万一会改变想法，或者在调试过程中想让它暂时失效。/*这部分代码因为已被它之前的代码取代，由B.Gustafsson,于1999年6月4日注释掉。如果两年之后还未使用，将其删除。...（源代码）*/单行在成员函数内采用单行注释，来说明业务逻辑、代码段和暂时变量的声明。//遵照Sarek的规定，给所有//超过$1000的发货单//打5%的折扣。让利活//动于1995年2月开始.2.2.3注释哪些部分下表概括了所写Java代码中的每一部分哪些需要注释说明。项目注释哪些部分实参/参数参数类型参数用来做什么任何约束或前提

9、条件示例成员/成员属性成员描述注释所有使用的不变量示例并行事件可见性决策类类的目的13已知的问题类的开发/维护历史注释出采用的不变量并行策略编译单元每一个类/类内定义的接口，含简单的说明文件名和/或标识信息版权信息获取成员函数若可能，说明为什么使用滞后初始化接口目的它应如何被使用以及如何不被使用局部变量用处/目的成员函数注释成员函数做什么以及它为什么做这个哪些参数必须传递给一个成员函数成员函数返回什么已知的问题任何由某个成员函数抛出的异常可见性决策成员函数是如何改变对象的包含任何修改代码的历史如何在适当情况下调用成员函数的例子适用的前提条件和后置条件