软件编程规范——JAVA.pdfVIP

1范围

本标准规定了Java语言的编程规范，主要包括基本原则、文件结构、注释、命名规则、

声、表达式与语句、类和接口等。

本标准适用于使用Java语言编码的所有软件。

2术语和定义

下列术语和定义适用于本标准。

2.1原则

编程时应该坚持的指导思想。

2.2规则

编程时必须遵守的约定。

2.3建议

编程时必须加以考虑的约定。

2.4说

对此规则或建议的必要的解释。

2.5正例

对此规则或建议给出的正确例子。

2.6反例

对此规则或建议给出的反面例子。

3基本原则

【原则】保持代码的简清晰，避免过分的编程技巧。

1-1

说说：：简单是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否则

会降低程序的可读性。

【原则】编程时首先达到正确性，其次考虑效率。

1-2

说说：：编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，其次考虑

程序的效率和资源占用。

【原则】保持一致性，尽可能多的使用相同的规则。

1-3

【原则】尽可能复用、修正原有的代码。

1-4

说说：：尽量选择可借用的代码，对其修改优化以达到自身要求。

1-5

【原则】尽量减少样的错误出现的次数。

说说明明：：事实上，我们无法做到完全消除错误，但通过不懈的努力，可以减少样的错误出现

的次数。

4文件结构

程序布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、

可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提

高开发效率，降低开发成本。时，对于普通程序员来说，养成良好的编程习惯有助于提高

自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人

主观美学上的或是形式上的问题，而且涉及到产品质量，涉及到个人编程能力的提高，必须

引起大家重视。

4.1基本格式

2-1-1.javaimport

【规则】源代码文件（）的布局顺序是：包、语句、注释、类。

正正例例:

packagecom.ati.**;ati

（是自动化技术研究所的简写，不一定恰当）

importjava.awt.peer.CanvasPeer;

importjava.io.*;

/**

*:

文件名称题目名称

*:

文件描述本类描述

*:(C)2001-2004

版权所有版权所有

*:

公司大连理工大学自动化研究所

*://

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

*://

其他说明其它内容的说明

*//

完成日期：输入完成日期

*version1.0

*author作者姓名

*修改记录1://修改历史记录，包括修改日期、修改者及修改内容

*

*修改日期：

*版本号：

*修改人：

*修改内容：

*

*2

修改记录：…

*/

publicclassClassName

{

}

2-1-2120

【规则】程序中一行的代码和注释不能超过列。

120

说说明明：：包括