项目编码规范编写指南

项目编码规范

1 命名规范

1）.包名采用域后缀倒置的加上自定义的包名，采用小写字母。

在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。

格式：

com.huawei.产品名.模块名称

com.huawei.部门名称. 项目名称

示例：

Relay模块包名 com.huawei.msg.relay

通用日志模块包名 com.huawei.msg.log

2）. 类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。

示例：

OrderInformation,

CustomerList,

LogManager,

LogConfig

3）. 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。

示例：

private void calculateRate();

public void addNewOrder();

4）. 方法中，存取属性的方法采用setter 和 getter方法，动作方法采用动词和动宾结构。格式：

get + 非布尔属性名()

is + 布尔属性名()

set + 属性名()

动词()

动词 + 宾语()

示例：

public String getType();

public boolean isFinished();

public void setVisible(boolean);

public void show();

public void addKeyListener(Listener);

5）.属性名使用意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。

示例：

private customerName;

private orderNumber;

private smpSession;

6). 常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用 final static 修饰。

示例：

public final static int MAX_VALUE = 1000;

public final static String DEFAULT_START_DATE = "2001-12-08";

7). 属性名可以和公有方法参数相同，不能和局部变量相同，引用非静态成员变量时使用 this 引用，引用静态成员变量时使用类名引用。

示例：

public class Person

{

private String name;

private static List properties;

public void setName (String name)

{

= name;

}

public void setProperties (List properties)

{

Person.properties = properties;

}

}

8).如果函数名超过15 个字母，可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。

示例：

getCustomerInformation() 改为 getCustomerInfo()

2 程序注释规范

1)、基本注释（必须加）

(a)类（接口）的注释

(b)构造函数的注释

(c)方法的注释

(d)全局变量的注释

(e)字段/属性的注释

备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO 对象的getter、setter方法不需加注释。

2)、特殊必加注释

(a)典型算法必须有注释。

(b)在代码不明晰处必须有注释。

(c)在代码修改处加上修改标识的注释。

(d)在循环和逻辑分支组成的代码中加注释。

(e)为他人提供的接口必须加详细注释。

3 程序代码书写规范

书写规范即在编写代码过程中所使用的标准格式，主要包括空格的使用、括号的使用、缩近格式和其他一些内容。

1). 每行代码的长度推荐为80列，最长不得超过120列；折行以对齐为准。

2). 在类的成员函数内调用其他类的成员函数时，其他类的成员函数可做简短说明。

3). 函数入口参数有缺省值时，应注释说明。

4). else if 必须写在一行。

5). 与空格有关的各项规定。

①所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘.’、‘[’、‘]’等运算符前后，及‘&’（取地址）等运算符之后不得有空格。

② or、while、if 等关键词之后应有1个空格，再接‘(’，之后无空格；在结尾的‘)’前不得有空格。

③调用函数时，‘(’、‘)’前后不得有空格。

④类型强制转换时，‘(’‘)’前后不得有空格

6). 与缩进有关的各项规定

①缩进以 Tab 为单位。1 个 Tab 为 4 个空格

②下列情况，代码缩进一个 Tab: 函数体相对函数名及‘{’、‘}’。

if、else、for、while、do 等之后的代码。一行之内写不下，折行之后的代码，应在合理的位置进行折行。若有 + - * / 等运算符，则运算符应在上一行末尾，而不应在下一行的行首。

③下列情况，不必缩进：switch 之后的 case、default。在switch-case结构中，case语句距离switch 语句的开始应缩进一个TAB，每个case的程序体距离case的开始缩进一个TAB;

④所有的函数定义和函数定义的花括号都应位于第一列；

⑤所有成对的花括号都应出现在同一列，并与相应的控制语句同列，在对数组、类、和枚举类型的成员初始化时，同样遵循此规则；