一、作用

项目开发过程中为了增加程序的可读性和程序的健壮性，方便后期程序的调试和维护，所以需要在开发过程中统一技术规范

 

二、目录

1.系统框架中模块功能，文件目录和文件名的规范

2.程序代码中文件名 类名  变量名 接口名等规范

3.代码的书写的规范

4.数据库中表名 字段名 数据类型等规范

 

三、详细内容

常用的命名风格如下。

(1)Pascal风格：包含一到多个单词，每一个单词第一个字母大写，其他字母小写，其余字母均小写。例如：CollegeStudent、HelloWorld等。

(2)Camel风格：包含一到多个单词，第一个单词首字母小写，其余单词首字母大写，其他字母均小写。例如：name、gender、somePara等。

 

四、系统框架功能模块、文件目录和文件名的规范

(1)功能模块命名规范

实体对象层：项目名.domain; ---封装数据所有Bean

数据访问层：项目名.dao;---数据访问层接口

项目名.dao.impl;---数据访问层实现

业务逻辑层：项目名.service;---业务逻辑层接口包

项目名.service.impl;---业务逻辑层实现包

控制管理层：项目名.web.controller;---处理请求的所有servlet

通用工具层：项目名.utils;---所需工具,可独立的类库

测试工具层：项目名.junit.test;---所有测试类

 

(2)文件目录的命名规范

images --项目图片的目录

styles  --项目css文件的目录

javascript --项目中js文件的目录

template  --项目模板文件的目录

subsystem --项目子系统或模块的目录(一般用因为名字来表示系统的模块)

document  --项目说明文档目录

database  --项目数据库目录

 

(3)文件名的命名规范

a.文件名尽量用一个或多个英文单词来表示做到见面知意的效果

比如:index.js  default.js  product.js  orderList.js等

b.所有单词的首字母要小写

c.尽量不要使用下划线来连接多个单词

 

五、程序代码中的命名规范

1：包名命名规范：例如项目名为 eex 那么包名 就写为 com.eex.user全部为小写 后缀一定要体现是哪个类型的包

 

2：类的命名规范：首字母大写，不要使用前缀，不要使用下划线命名

 

3：私有成员命名规范 全部小写 采用驼峰命名法

例如 这个类是User , 用户名就为 userName

 

4：属性命名规范和私有成员一样

 

5：方法命名规范：通常每个方法都是执行类的一个“动作”，所以对方法的命名应该清楚地说明该方法是做什么的，用“动词+名词”的结构可以更加清晰的表达这种含义。例如，用showInfo()代替info()，用loadData()代替dataLoad()，这样做的目的是更加明确这个方法的功能。也是采用驼峰命名法。

 

6：方法参数命名规范：采用全小写

 

7：接口命名规范：

a.使用I作为前缀，表示其为一个接口。

b.使用名词或名词短语，或者描述行为的形容词来命名接口。

例如IComponent（描述性名词）、ICustomAttributeProvider（名词短语）和IPersistable（形容词）。

c.尽量不使用缩写，而用全写。例如：使用IComponent而不用IComp。

d.不要使用带下划线的字符（例如ICustom_AttributeProvider）。

 

8：变量命名规范：采用驼峰命名法

 

9：常量和全局变量：全部采用大写

 

六.代码的书写的规范

a.缩进和间隔 --代码要有相应的缩进量和相应的间隔这让代码看起来有一定的层次感觉有利于增加代码的可读性

b.注释   --重要的方法和模块要有相应的注释，注释内容一行以内的用单行注释，超过一行的用多行注释的

c.多类单文件 --一个类尽量放在一个文件中，避免多个类放在一个文件中造成代码混乱

d.大小括号位置要对齐--大小括号的位置尽量对齐也就是要有相应的缩进和间隔

 

七.数据库中表名 字段名 数据类型等规范

(1)数据库取名规范

a. 数据库名一般使用小写字母的形式 例如：eshopdb   db_eduask

b. 数据库取名一般有两种方式：名词+db 或者 db_名词  

c. 数据库命名一般用全名不要用缩写比如 不用eshdb而是用eshop

例如：eshopdb   db_eduask  但推荐使用db_eduask

 

(2)表名取名规范

a. 表名一般使用小写字母的形式 例如：productstab  tab_products

b.表名取名一般有两种方式：名词+tab 或者 tab_名词

c.表名命名一般用全名不要用缩写比如 不用tab_pro而是用tab_products

例如：eshopdb 和db_eduask 但推荐使用tab_products

 

(3)字段名取名规范

a.字段名一般使用 数据类型缩写+"_"+描述 的形式

b.字段名一般采用全部小写的形式

 

字段类型简写:

字符型为c, 整型为i, 逻辑型为b, 货币类型为m,

浮点型为f, 日期型为d, 时间型为t, 二进制为bl,

文本类型为t, varchar类型为v, nvarchar类型为nv等。

 

例如 n_name n表示数据类型,name表示描述

 

(4)数据类型统一采用小写 char(10)  nvarchar(10) text int等

(5)索引(index)的命名 idx_desc

(6)存储过程的命名  sp_desc

(7)视图的名词  view_desc

(8)触发器的命名 trg_desc

(9)SQL语句书写规范

SQL语句中，SQL关键字全部大写，其它的遵照"数据库命名约定"。例如：

SELECT * FROM tabNewsInfo WHERE f_UserName=' ' ORDER BY i_autoid


注意：本文归作者所有，未经作者允许，不得转载