编码规范细则_Java.doc

《编码规范细则_Java.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、技术文件技术文件名称：编码规范细则_Java技术文件编号：版本：1.0共37页(包括封面)拟制　审核会签标准化批准目录前言41范围52术语和定义52.1原则52.2规则52.3建议52.4说明52.5正例52.6反例53代码布局53.1基本格式53.2对齐73.3空行空格83.4断行94注释115命名规则166声明227表达式与语句228类和接口269附编程实例28版本变更记录版本号拟制/修改日期拟制/修改人修改记录批准人注：1）拟制、审核、会签、批准不走电子流程时，必须用钢笔或签字笔填写，不得用铅笔、圆珠笔填写，不得涂改。<本模板中用“<>”括

2、起来的内容包括本段，是编写指导，在最终的文档中应予以删除。其它内容应予以保留。如果某节内容无需填写，则在该节下写“无”，而不要将本节删除或不填写任何内容（留白将无法判断：是本节内容无需填写还是因为疏忽而忘了填写。）>前言编码规范包括总则和细则两部分。总则部分是对编码的总体性规范要求，适用于多种编码语言；细则部分是在总则的规范要求下，针对具体语言的特点而提出的规范要求。本规范是编码规范的细则部分，适用于JAVA编程语言。编写本规范的目的是为了进一步规范JAVA软件编程风格，提高软件源程序的可读性、可靠性和可重用性，确保在开发成员或开发团队之间的工作

3、可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作，提高软件源程序的质量和可维护性，减少软件维护成本。本规范的内容包括：代码布局、注释、命名规则、声名、表达式与语句、类与接口等。规范最后给出了一个编程实例供软件人员参考。本规范分成规则性和建议性两种：对于规则性规范，要求所有软件开发人员严格执行；对于建议性规范，各项目编程人员可以根据实际情况选择执行。自本规范实施之日起，以后新编写的和修改的代码均应执行本规范1范围本标准规定了Java语言的编程规范，主要包括基本原则、布局、注释、命名规则、声明、表达式与语句、类和接口等

4、。本规范自生效之日起，对以后新编写的和修改的代码有约束力。2术语和定义下列术语和定义适用于本标准。2.1原则编程时应该坚持的指导思想。2.2规则编程时必须遵守的约定。2.3建议编程时必须加以考虑的约定。2.4说明对此规则或建议的必要的解释。2.5正例对此规则或建议给出的正确例子。2.6反例对此规则或建议给出的反面例子。3代码布局代码布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、可维护性。更重要的是，统一的代码布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程

5、习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且涉及到产品质量，涉及到个人编程能力的提高，必须要引起重视。3.1基本格式【规则3-1-1】源代码文件（.java）的布局顺序是：包、import语句、类。正例:packagecom.zte;importjava.awt.peer.CanvasPeer;importjava.io.*;importcom.zte.ums.uep.*;publicclassClassName{}【规则3-1-2】遵循统一的布局顺序来书写imp

6、ort语句，不同类别的import语句之间用空行分隔。说明：package语句其后可跟import语句，而且与package间隔一个空行。import包的排列顺序为java开头的包在最前面，接下来是引自外部的包，再接下来是应用程序自身的包，即import中标准的包名要在本地的包名之前，而且按照字母顺序排列。正例:packagecom.zte;importjava.awt.peer.CanvasPeer;//java自身的包importjava.io.*;importcom.klg.field.*;//第三方的包importcom.zte.ums.

7、uep.*;//程序自身的包【规则3-1-3】if、else、elseif、for、while、do等语句独占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。说明：这样可以防止书写失误，也易于阅读。正例：if(varible1

8、10;width=5;//矩形的长与宽关系较密切，放在一起。strCaption=“Test”;反例：length=10;strCapt