Java编码规范.doc

文档介绍：中测高科(北京)测绘工程技术有限责任公司
(国家测绘工程技术研究中心)
C#编程规范
V
二○一二年九月
一、目的及意义
本规范以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强灵活性,以期提供一整套使用于本中心内部Java 代码的标准、约定和指南,从而提高 Java 软件开发者的生产效率,为开发团队的程序设计带来更大的一致性,使软件开发团队的效率明显提高。
主要用途:
利于开发人员查看自己代码或他人代码能更快的理解;
利于开发人员对代码的维护操作,修改Bug;
利于软件工程项目的重用、持续发展。
具体实施的时候可能比较多,比较繁琐,一般来说注意变量命名、注释按照文中执行。
二、适用范围
本文档适用于项目组内进行软件开发的所有技术人员,即项目组内软件开发人员编写的所有源代码都必须遵循本规范。
除临时性项目之外的任何项目均应严格按照此标准执行,“临时性项目”指:
Ø为市场推广目的而编写的示例程序
Ø为一次性用途而编写的临时性小程序
为学****目的而编写的测试程序
三、一般规则
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读,应该尽量避免。
Java源文件必须遵循以下规则:

所有的源文件都应该在开头有一个C语言风格的注释,其中列出文件名、作者、公司、日期、描述、修改说明和版权声明:
/**
* File:
* ***@author xxx
* ***@version:
* Date: 03/08/2008
* Modify:
* Description:
*/
//这在Java语法中有严格规定
在Java源文件中,第一个非注释行是Package语句。Package 行要在 Import 行之前,Import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。例如:
package ;
import ;
import ;
.;

在Java类中首先是类的公共变量,随后是受保护的变量,再后是包一级别的变量(没有访问修饰符,access modifier),最后是私有变量。
推荐一行一个声明,因为这样以利于写注释。亦即,
int level; // indentation level
int size; // size of table
要优于,int level, size;
不要将不同类型变量的声明放在同一行,例如:
int foo, fooarray[]; //避免!
另:变量如果多的话最好有注释如:private String strActiveFile; \\文件名。
四、代码格式

4个空格常被作为缩进排版的一个单位,以表示缩进,显示程序的层次级别,增加程序的可读性。不要在源代码中保留tab字符,这是因为tab字符会随着不同用户的不同设置和不同的资源管理工具(打印、文档、版本控制等)而代表不同的宽度。

l 尽量避免一行的长度超过80个字符,因为很多终端和工具不能很好处理之。注意:用于文档中的例子应该使用更短的行长,长度一般不超过70个字符。

当一个表达式无法容纳在一行内时,可以依据如下一般规则断开之:
在一个逗号后面断开;
在一个操作符前面断开;
宁可选择较高级别(higher-level)的断开,而非较低级别(lower-level)的断开;
新的一行应该与上一行同一级别表达式的开头处对齐;
如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边,那就代之以缩进8个空格。
以下是断开方法调用的一些例子:
someMethod(longExpression1, longExpression2, longExpression3,
longExpression4, longExpression5);
var = someMethod1(longExpression1,
someMethod2(longExpression2,
longExpression3));
以下是两个断开算术表达式的例子。前者更好,因为断开处位于括号表达式的外边,这是个较高级别的断开。
longName1 = longName2 * (longName3 + longName4 - longName5)
+ 4 * longname6; //PREFFER
longN