《软件编程规范—java(修改稿)》由会员分享，可在线阅读，更多相关《软件编程规范—java(修改稿)（36页珍藏版）》请在金锄头文库上搜索。
1、软软件件编编程程规规范范 - -Java（正式版）中兴软件技术（南昌）有限公司中兴软件技术（南昌）有限公司版权所有版权所有 不得复制不得复制软件编程规范Java 篇第 2 页 共 36 页修订记录修订记录日日 期期修订版本修订版本描描 述述修改人修改人2006-03-08正式版完成编程规范小组软件编程规范Java 篇第 3 页 共 36 页目目 录录目 录.3 前 言.4 1 基本原则.5 2 文件结构.6 2.1 基本格式.6 2.2 对齐.8 2.3 空行空格.9 2.4 断行.11 3 注释.14 4 命名规则.20 5 声明.26 6 表达式与语句.27 7 类和接口.31 附 录.3
2、4 附录 A 编程模版.34 参考文献.36软件编程规范Java 篇第 4 页 共 36 页前前 言言软件编程规范的目的是为了统一公司软件编程风格，提高软件源程序的可读性、可靠 性和可重用性，提高软件源程序的质量和可维护性，减少软件维护成本，最终提高软件产 品生产力。 本规范是针对 JAVA 语言的编程规则。本规范适用于公司所有产品的软件源程序，同 时考虑到不同产品和项目的实际开发特性，本规范分成规则性和建议性两种：对于规则性 规范，要求所有软件开发人员严格执行；对于建议性规范，各项目编程人员可以根据实际 情况选择执行。本规范的示例都以 JAVA 语言描述。 本规范的内容包括：基本原则、文件结
3、构、注释、命名规则、声明、表达式与语句、 类和接口等。规范最后给出了标准模板供软件人员参考。 本规范由软件编程规范小组编写 本规范自生效日期起，对以后新编写的和修改的代码有约束力。对以前的代码不要求 进行修改。对于由开发工具自动生成的代码可以不约束。 对本规范中所使用的术语解释如下： 原则：原则：编程时应该坚持的指导思想。 规则：规则：编程时必须遵守的约定。 建议：建议：编程时必须加以考虑的约定。 说明：说明：对此规则或建议的必要的解释。 正例：正例：对此规则或建议给出的正确例子。 反例：反例：对此规则或建议给出的反面例子。软件编程规范小组2006年3月8日软件编程规范Java 篇第 5 页
4、共 36 页1 基本原则基本原则说明：说明：这是软件开发的基本要点，软件的生命周期贯穿产品的开发、测试、生产、用户使 用、版本升级和后期维护等长期过程，只有易读、易维护的软件代码才具有生命力。说明：说明：简单是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否 则会降低程序的可读性。说明：说明：编程时以公司的规范为准，公司的规范没有规定的内容参考上面的标准。说明：说明：编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，其次考 虑程序的效率和资源占用。说明：说明：尽量选择可借用的代码，对其修改优化以达到自身要求。说明：说明：事实上，我们无法做到完全消除错误，但通过
5、不懈的努力，可以减少同样的错误出 现的次数。【原则 1-1】首先是为人编写程序，其次才是计算机。【原则 1-2】保持代码的简明清晰，避免过分的编程技巧。【原则 1-3】所有的代码尽量遵循 SUN 的Code Conventions for the JavaTM Programming Language标准（参见：http:/ 。【原则 1-4】编程时首先达到正确性，其次考虑效率。【原则 1-5】保持一致性，尽可能多的使用相同的规则。【原则 1-6】尽可能复用、修正原有的代码。【原则 1-7】 尽量减少同样的错误出现的次数。软件编程规范Java 篇第 6 页 共 36 页2 文件结构文件结构程序
6、布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、 可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量， 提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于 提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅 是个人主观美学上的或是形式上的问题，而且涉及到产品质量，涉及到个人编程能力的提 高，必须引起大家重视。2.1 基本格式基本格式正例正例:package com.zte; import java.awt.peer.CanvasPeer; import java.io.*;import c
7、om.zte.ums.uep.*;/* 文件名称: 题目名称* 文件描述: 本类描述* 版权所有: 版权所有(C)2006* 公 司: 中兴软件技术（南昌）有限公司* 内容摘要: / 简要描述本文件的内容，包括主要模块、函数及其功能的说明* 其他说明: / 其它内容的说明* 完成日期：/ 输入完成日期，例：2006 年 2 月 25 日* 修改记录 1: / 修改历史记录，包括修改日期、修改者及修改内容* * 修改日期：* 版 本 号：* 修 改 人：* 修改内容：* * 修改记录 2：* version 1.0* author 作者姓名【规则 2-1-1】源代码文件（.java）的布局顺序是
8、：包、import 语句、注释、类。软件编程规范Java 篇第 7 页 共 36 页*/public class ClassName 说明：说明：package 语句其后可跟 import 语句，而且与 package 间隔一个空行。import 包的排列 顺序为 java 开头的包在最前面，接下来是引自外部的包，再接下来是应用程序自身 的包，即 import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。正例正例:package com.zte; import java.awt.peer.CanvasPeer;/java 自身的包 import java.io.*;import co
9、m.klg.field.*;/第三方的包import com.zte.ums.uep.*;/程序自身的包说明：说明：包括空格在内不超过 120 列。说明：说明：这样可以防止书写失误，也易于阅读。正例：正例： if (varible1 文件名称: 题目名称* 文件描述: 本类描述* 版权所有: 版权所有(C)2006* 公 司: 中兴软件技术（南昌）有限公司* 内容摘要: / 简要描述本文件的内容，包括主要模块、函数及能的说明* 其他说明: / 其它内容的说明* 完成日期：/ 输入完成日期，例：2006年2月25日* 修改记录1: / 修改历史记录，包括修改日期、修改者及修改内容* * 修改日期：* 版 本 号：* 修 改 人：* 修改内容：* * 修改记录2：* version 1.0* author 作者姓名*/说明：说明：注释必须列出：功能描述、输入参数、返回值等，对于成员属性的 get/set 操作可以 不加注释。正例：正例：下面是公共方法头部的注释：/* 这是对下面的方法进行文档型注释的第一行内容。* 这是对下面的方法进行文
