：制定开发/设计规约

Posted 2022-04-28 zhenghhgz

一、代码规范

1.1 命名规范：

1. 项目主名为大写开头驼峰命名，子项目名全部小写。
2. 包名全部小写。
3. 类名首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写。

public class MyOrder

1. 变量名、方法名首字母小写。

int index = 0;

1. 常量名全部大写。

public static final String ACTIVITY_TYPE = "1"；

1. 所有命名规则必须遵循以下规则：

● 名称只能由字母、数字、下划线、$符号组成。
● 不能以数字开头
● 名称不能使用JAVA中的关键字。
● 坚决不允许出现中文及拼音命名。

1.2 注释规范：

1. 类注释

在每个类前面必须加上类注释，注释模板如下：

/**
  * 功能描述
  * @author 类创建者姓名
  * @Date    创建日期
  * @version 1.00
*/

2. 属性注释

在每个属性前加上属性注释，注释模板如下：

/** 提示信息**/
private String name = null;

3. 方法注释

在每个方法前必须加上方法注释，注释模板如下：

/**

  * 类方法的详细使用说明

  * @param 参数1 参数1的使用说明

  * @return 返回结果的说明

  * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

4. 构造方法注释

在每个构造方法前必须加上注释，注释模板如下：

/**

  * 构造方法的详细使用说明

  * @param 参数1 参数1的使用说明

  * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

5. 方法内部注释

在方法内部使用单行或多行注释，该注释根据实际情况添加。

二、数据库设计规范

4.1 基本命名原则

Ø规范：字母全部小写原则

所有数据库对象命名字母全部小写，统一大小写有助于在多数据库间转移。

Ø规范：字符范围原则

只能使用英文字母、下划线、数字进行命名，且首位字符必须是英文字母。

Ø规范：分段命名原则

命名中多个单词间采用下划线分割，以便阅读同时方便某些工具对数据库对象的映射。例如：user_name。

Ø规范：不要用保留词

数据库对象命名不能直接使用数据库保留关键字，但分段中可以使用。如user不能用于表名、列名等，但是user_name可以用于列名，user_info也可以用于表名。

Ø规范：同义性原则

对于同一含义尽量使用相同的单词命名，不管使用英文单词、英文缩写还是拼音首字母，以免引起误解。如telphone的A表中表示固定电话号码，在B表中就不应该用于表示移动电话号码。尽量避免同一单词表示多种含义的情况。

Ø规范：命名方式一致原则在一个系统、一个项目中尽量采用一致的命名方式，都采用英文单词或者拼音首字母。尤其要避免在一个对象命名中同时采用英文单词和拼音首字母。如确实需要在一个项目中采用两种命名方式，考虑系统功能设计相关表（开发）使用英文单词命名，业务相关的表（实施）使用拼音首字母。

4.2 命名前缀规范

Ø规范：以下对象命名采用固定前缀进行命名，前缀表示数据库对象的类型，前缀代码规范如下：

4.3 表和列规范

4.3.1 表规范

Ø规范：表名采用多段式命名，各单词间用下划线分隔；

Ø规范：表名只允许用英文字母、下划线、数字进行命名，不允许用中文或者其他符号；

Ø规范：表名全部字母小写；

Ø规范：根据历史习惯各系统常用表类前缀作如下约定：

Ø建议：表名也用于相关索引、分区、分区表空间、约束、主键等命名，因此为了避免相关对象命名长度超过限制，建议表名长度不要超过20。

4.3.2 列规范

Ø建议：列名只允许用英文字母、下划线、数字进行命名，不允许用中文或者其他符号。

Ø规范：列名字母全部小写。

Ø规范：列名采用多段式命名时，各单词间用下划线分隔；

Ø规范：列名不能直接使用数据库保留字；

Ø规范：日期类型字段推荐以“_date”结尾的名字命名，时间类型的字段推荐以“_time”结尾的名字命名。

4.3.3 常用字段规范