软件编程规范—java

《软件编程规范—java》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、软件编程规范－Java篇软件编程规范-Java（正式版）深圳市中兴通讯股份有限公司版权所有不得复制第36页共36页软件编程规范－Java篇修订记录日期修订版本描述修改人2002-09-18试用版初稿完成编程规范小组2002-09-25试用版根据9月中旬南京集中讨论的结果进行修改编程规范小组2003-03-08正式版根据事业部收集的意见进行讨论修改编程规范小组第36页共36页软件编程规范－Java篇目录目录3前言41基本原则52文件结构62.1基本格式62.2对齐82.3空行空格92.4断行113注释14

2、4命名规则205声明266表达式与语句277类和接口31附录34附录A编程模版34参考文献36第36页共36页软件编程规范－Java篇前言软件编程规范的目的是为了统一公司软件编程风格，提高软件源程序的可读性、可靠性和可重用性，提高软件源程序的质量和可维护性，减少软件维护成本，最终提高软件产品生产力。本规范是针对JAVA语言的编程规则。本规范适用于公司所有产品的软件源程序，同时考虑到不同产品和项目的实际开发特性，本规范分成规则性和建议性两种：对于规则性规范，要求所有软件开发人员严格执行；对于建议性规范，各

3、项目编程人员可以根据实际情况选择执行。本规范的示例都以JAVA语言描述。本规范的内容包括：基本原则、文件结构、注释、命名规则、声明、表达式与语句、类和接口等。规范最后给出了标准模板供软件人员参考。本规范由软件编程规范小组编写，主要成员如下技术中心：李军、刘继兴、李彬、刘成军网络事业部：杨扬、吴豫宁、金晓静CDMA事业部：王艺平、孙世强移动事业部：刁影川、朱成荣、姚文军本部事业部：唐李卉、李兴国本规范于2002年9月首次发布试用版，2003年4月发布1.0版。本规范自生效日期起，对以后新编写的和修改的代码

4、有约束力。对以前的代码不要求进行修改。对于由开发工具自动生成的代码可以不约束。对本规范中所使用的术语解释如下：原则：编程时应该坚持的指导思想。规则：编程时必须遵守的约定。建议：编程时必须加以考虑的约定。说明：对此规则或建议的必要的解释。正例：对此规则或建议给出的正确例子。反例：对此规则或建议给出的反面例子。软件编程规范小组2003年3月8日第36页共36页软件编程规范－Java篇1基本原则【原则1-1】首先是为人编写程序，其次才是计算机。说明：这是软件开发的基本要点，软件的生命周期贯穿产品的开发、测试、

5、生产、用户使用、版本升级和后期维护等长期过程，只有易读、易维护的软件代码才具有生命力。【原则1-2】保持代码的简明清晰，避免过分的编程技巧。说明：简单是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否则会降低程序的可读性。【原则1-3】所有的代码尽量遵循SUN的《CodeConventionsfortheJavaTMProgrammingLanguage》标准（参见：http://java.sun.com/docs/codeconv/）。说明：编程时以公司的规范为准，公司的规范没有规定

6、的内容参考上面的标准。【原则1-4】编程时首先达到正确性，其次考虑效率。说明：编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，其次考虑程序的效率和资源占用。【原则1-5】保持一致性，尽可能多的使用相同的规则。【原则1-6】尽可能复用、修正原有的代码。说明：尽量选择可借用的代码，对其修改优化以达到自身要求。【原则1-7】尽量减少同样的错误出现的次数。说明：事实上，我们无法做到完全消除错误，但通过不懈的努力，可以减少同样的错误出现的次数。第36页共36页软件编程规范－Java篇2文件结构程

7、序布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且涉及到产品质量，涉及到个人编程能力的提高，必须引起大家重视。2.1基本格式【规则2-1-1】源代码文件（.java）的布局顺序是：包、import语句、注释、类

8、。正例:packagecom.zte;importjava.awt.peer.CanvasPeer;importjava.io.*;importcom.zte.ums.uep.*;/***

文件名称:题目名称

文件描述:本类描述

版权所有:版权所有(C)2001-2004

公司:深圳市中兴通讯股份有限公司

内容摘要://简要描述本文件的内容，包括主要模块、函数及其功能的说明