软件编程规范JAVA.docx

1范围 本标准规定了 Java语言的编程规范，主要包括基本原则、文件结构、注释、命名规则、声明、 表达式与语句、类和接口等。 本标准适用于使用 Java语言编码的所有软件。 2术语和定义 下列术语和定义适用于本标准。 2.1 原则 编程时应该坚持的指导思想。 22 规则 编程时必须遵守的约定。 建议 编程时必须加以考虑的约定。 说明 对此规则或建议的必要的解释。 正例 对此规则或建议给出的正确例子。 反例 对此规则或建议给出的反面例子。 3基本原则 【原则1-1】保持代码的简明清晰，避免过分的编程技巧。 说明： 简单 是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否则会降低程序的 可读性。 【原则1-2】编程时首先达到正确性，其次考虑效率。 如力. 编 程 首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，其次考虑程序的效率和 资源占用。 【原则1-3】保持一致性，尽可能多的使用相同的规则。 【原则1-3】保持一致性，尽可能多的使用相同的规则。 【原则1-4】尽可能复用、修正原有的代码。 说明： 尽 量 选 择 可 借 用的代码，对其修改优化以达到自身要求。 说明： 事实【原则1-5】 尽量减少同样的错误出现的次数。 说明： 事实 上，我们无法做到完全消除错误，但通过不懈的努力，可以减少同样的错误出现的次数。 4文件结构 程序布局的目的是显示出程序良好的逻辑结构， 提高程序的准确性、连续性、可读性、可维护性。 更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开 发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效 率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且 涉及到产品质量，涉及到个人编程能力的提高，必须引起大家重视。 4.1 基本格式 【规则2-1-1】源代码文件（.java ）的布局顺序是：包、import语句、注释、类。 正例： package .**; （ ati是自动化技术研究所的简写，不一定恰当） import .*; /** p文件名称p p文件名称 p文件描述 p版权所有 p公 司 p内容摘要 本类描述/p 版权所有（C）2001-2004/p 大连理工大学自动化研究所 /p  yMeth od() { if (con diti on) { count = 1; } } 〖建议6-1〗循环嵌套次数不大于 3次。 来 6类 和接口 【规则7-1】类内部的代码布局顺序：属性、构造函数、方法。 正例： class Test { public String n ame; public Test() { ...* 5 } public void setName(String name) { private void method。 { } } 〖建议7-1〗功能相关的方法放在一起。 说明：如接口中关系较紧密的的几个方法，类属性的 get和set方法，有调用关系的方法，重载的 方法等有相近或相关的方法尽可能放在一起，方便阅读。 正例： class Sample exte nds Object { int ivar1; int ivar2; Stri ng n ame; Sample。nt i, i nt j) { ivar1 = i; ivar2 = j; } public void setName(Stri ng n ame) { =n ame; } public String getName() { return ; } int method1 () { method2(); } void method2() { 说明： 过多} 说明： 过多 1建议7-2〗函数的参数个数不宜超过 4个。 的函数参数会导致性能降低。 1建议7-3〗保证内部类定义成 private ，提高类的封装性。