Java编码规范-细则.docVIP

技 术 文 件 技术文件名称：Java编码规范-细则 技术文件编号： 版 本：1.3 共 38 页 (包括封面) 拟 制 　 审 核 会 签 标准化 批 准 中兴通讯股份有限公司 质企中心IT部  目 录 前 言 4 1 范围 5 2 术语和定义 5 2.1 原则 5 2.2 规则 5 2.3 建议 5 2.4 说明 5 2.5 正例 5 2.6 反例 5 3 代码布局 5 3.1 基本格式 5 3.2 对齐 7 3.3 空行空格 8 3.4 断行 9 4 注释 11 5 命名规则 16 6 声明 22 7 表达式与语句 23 8 类和接口 27 9 附编程实例 29 版本变更记录 版本号 拟制/修改日期 拟制/修改人 修改记录 批准人 1.1 2004-7-15 于平 删去基本原则部分，在规范总则中体现；对注释部分进行修改；增加编程实例;修改部分命名规则。 2004-10-9 陈沛 增加了类编号说明; 取消类头的方法属性列表要求；取消方法编号要求。 1.3 2005-3-16 韩荣华 根据过程资产库架构指南调整文件名及引用 陈沛 注： 1）拟制、审核、会签、批准不走电子流程时，必须用钢笔或签字笔填写，不得用铅笔、圆珠笔填写，不得涂改。 本模板中用“ ”括起来的内容包括本段，是编写指导，在最终的文档中应予以删除。其它内容应予以保留。 如果某节内容无需填写，则在该节下写“无”，而不要将本节删除或不填写任何内容（留白将无法判断：是本节内容无需填写还是因为疏忽而忘了填写。） 前 言 编码规范包括总则和细则两部分。总则部分是对编码的总体性规范要求，适用于多种编码语言；细则部分是在总则的规范要求下，针对具体语言的特点而提出的规范要求。本规范是编码规范的细则部分，适用于JAVA编程语言。 编写本规范的目的是为了进一步规范JAVA软件编程风格，提高软件源程序的可读性、可靠性和可重用性，确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作 范围 本标准规定了Java语言的编程规范，主要包括基本原则、布局、注释、命名规则、声明、表达式与语句、类和接口等。 本规范自生效之日起，对以后新编写的和修改的代码有约束力。 术语和定义 下列术语和定义适用于本标准。 原则 编程时应该坚持的指导思想。 规则 编程时必须遵守的约定。 建议 编程时必须加以考虑的约定。 说明 对此规则或建议的必要的解释。 正例 对此规则或建议给出的正确例子。 反例 对此规则或建议给出的反面例子。 代码布局 代码布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、可维护性。更重要的是，统一的代码布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且涉及到产品质量，涉及到个人编程能力的提高，必须要引起重视。 基本格式 【规则3-1-1】源代码文件（.java）的布局顺序是：包、import语句、类。 正例: package com.zte; import java.awt.peer.CanvasPeer; import java.io.*; import com.zte.ums.uep.*; public class ClassName { } 【规则3-1-2】遵循统一的布局顺序来书写import语句，不同类别的import语