BAMS 二次开发文档

约定的编码规范

发布时间 2015-01-05 16:38   浏览量()   收藏()

一、规范存在的意义

好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;

好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码;

好的编码规范可以最大限度的提高团队开发的合作效率;

长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维;


二、命名规范

尽量使用完整的英文描述符

采用适用于相关领域的术语

采用大小写混合使名字可读

尽量少用缩写,但如果用了,必须符合整个工程中的统一定义

避免使用长的名字(小于 15 个字母为正常选择)

避免使用类似的名字,或者仅仅是大小写不同的名字

避免使用下划线(除静态常量等)

所有Pojo类与数据库表名对应

所有Dao接口类继承自BaseDao,以I打头,以pojo类名称+Dao结束

所有Daoimpl实现类以pojo类名称+DaoImpl结束

所有业务接口类以I打头,以业务名称+Service结束

所有业务实现类:业务名称+Service;

所有Dwr控制类,以Dwr打头,已业务名称+Service结束


三、标识符类型说明

1、包( Package )的命名:

采用完整的英文描述符,都是由一个小写单词组成

2、类( Class )的命名: 

类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量保证类名简洁而富于描述。

使用完整单词,避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用

3、接口( Interface )的命名:

基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上,保证开头第一个字母为 ”I”,便于与普通的 Class区别开

4、枚举( Enum )的命名:

参考EnumUtil类

5、异常( Exception )的命名

6、方法( Method )的命名

在service中,操作数据库更新、写入、删除,方法名以update、save、edit、add、move、delet、remove打头,保证spring事务托管的有效;对数据的查询采用 list、get、find打头;

一般方法遵循:

方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头

例如:

返回类型为 Boolean 值:用“ is ”或“ has ”来开头

得到某数据: get+ 数据描述名词复数 + 数据类型;

得到所有数据: get+All+ 数据描述名词复数 + 数据类型;

通过 XXX 得到 / 查询某数据: get/query+ 数据描述名词复数 + 数据类型 +By+ 条件;

添加某数据: save/add+ 数据描述名词 ()

更新某数据: save/update+ 数据描述名词;

删除某数据: delete/remove+ 数据描述名词;

7、参数( Param )的命名:

第一个单词的首字母小写,其后单词的首字母大写。参数量名不允许以下划线或美元符号开头,虽然这在语法上是允许的。参数名应简短且富于描述。

8、常量字段 ( Constants )的命名:

静态常量字段( static final ) 全部采用大写字母,单词之间用下划线分隔;

参考:ConstWords类


广告会让浏览体验不好,可这是网站的唯一收入,请点击下面的百度广告,支持老高的开源行动吧!