JAVA编程规约

《JAVA编程规约》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、校园有线网解决方案合肥智同信息技术有限公司JAVA编程规约1/1JAVA编程规约智同公司版权所有1目录第1章修改履历1第2章基本规则22.1总体要求22.2可读性要求22.3结构化要求22.4正确性与容错性要求32.5可重用性要求3第3章文件结构43.1文件头声明43.2函数/过程说明4第4章命名规则54.1变量命名54.2窗体命名54.3用户控件的命名54.4函数命名54.5控件的命名6第5章注释的规范75.1需要注释的地方75.2注释的要求7合肥智同信息技术有限公司电话：0551-53150525

2、325625传真：0551-5315052-808JAVA编程规约智同公司版权所有9第1章修改履历编号版本修改说明担当者修改时间1．1.0初版作成孙曙光2007-6合肥智同信息技术有限公司电话：0551-53150525325625传真：0551-5315052-808JAVA编程规约智同公司版权所有9第1章基本规则1.1总体要求1.程序结构清析，简单易懂，单个函数的程序行数最好不超过100行。2.打算干什么，要简单，直接了当，代码精简，避免垃圾程序。3.尽量使用标准库函数和公共函数。4.不要随意定义

3、全局变量，尽量使用局部变量。5.使用括号以避免二义性。1.2可读性要求1.可读性第一，效率第二。2.保持注释与代码完全一致。3.每个源程序文件，都有文件头说明，说明规格见规范。4.每个函数，都有函数头说明，说明规格见规范。5.主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。6.常量定义（staticfinalString）有相应说明。7.处理过程的每个阶段都有相关注释说明。8.在典型算法前都有注释。9.利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为4个字节。1

4、0.循环、分支层次不要超过五层。11.注释可以与语句在同一行，也可以在上行。12.空行和空白字符也是一种特殊注释。13.一目了然的语句不加注释。14.注释的作用范围可以为：定义、引用、条件分支以及一段代码。15.注释行数（不包括程序头和函数头说明部份）应占总行数的1/5到1/3。1.3结构化要求1.禁止出现两条等价的支路。2.禁止GOTO语句。合肥智同信息技术有限公司电话：0551-53150525325625传真：0551-5315052-808JAVA编程规约智同公司版权所有91.用IF语句来强调

5、只执行两组语句中的一组。禁止ELSEGOTO和ELSERETURN。2.用CASE实现多路分支。3.避免从循环引出多个出口。4.函数只有一个出口。5.不使用条件赋值语句。6.避免不必要的分支。7.不要轻易用条件分支去替换逻辑表达式。1.1正确性与容错性要求1.程序首先是正确，其次是优美2.无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。3.改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。4.所有变量在调用前必须被初始化。5.对所有的用户输入，必须进行合法性检查。6.

6、不要比较浮点数的相等，如：10.0*0.1==1.0，不可靠7.程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。8.单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。1.2可重用性要求1.重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。2.公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。3.公共控件或类应建立使用模板。合肥智同信息技术有限公司电话：0551-53150525325625传真：0551-5315052-

7、808JAVA编程规约智同公司版权所有9第1章文件结构每个程序通常分为两类文件。一类文件用于保存画面呈现控件信息（.jsp文件），称为jsp文件。另一类文件用于保存程序的实现（.java文件）。1.1文件头声明在每个.java文件的声明，主要内容有：1.包名。2.类名、文件名称。3.画面名称，程序功能描述。4.作者信息5.当前版本号，版本信息。/***パッケージ名：jp.co.swc.fk.action*クラス名　　：FK001P_R01_PrintAction.java*

*振替伝票入力画面_振

8、替処理書印刷のアクションクラス*

**@authorCNES*@version1.00[新規作成]*/1.2主函数说明包括作用描述,返回值(如果是函数的话)和输入参数说明(类型,可能的值域).示例如下：/***

振替処理書印刷処理を行う。