java项目规范_Java项目开发规范约定

项目开发约定

1项目通用命名规则

1.1 命名方式

文件名、变量名称使用有意义的英文(或缩写)进行命名，名称与数据表结构的名称命名保持一致，便于提高查阅效率。所有由多个单词组成的名称统一用驼峰法则进行命名。驼峰法则是由一个或多个单字连结在一起，而构成的唯一识别字时，第一个单字以小写字母开始，第二个单字的首字母大写或每一个单字的首字母都采用大写字母，例如：name、myFirstName。

1.2 注释

文本注释

文本注释可方便快速了解相关内容的主要功能及其作用信息。当对方法、对象、类进行注释时，使用文本注释，以方便在其他地方调用时也可查看到此注释信息，注释方式如下：/**

*描述信息

*[author 开发人员]

*/

段落注释

当注释内容较多时，使用段落注释。注释方式如下：

/*

描述信息

……

*/

单行注释

对某些关键代码进行单行注释是有必要的，是提高后期代码维护利器，可减少很多没必要操作。单行注释使用双斜线进行注释(快捷键Ctrl + C)，注释方式如下：

//描述信息

2Java相关命名规侧

2.1 类的包路径命名

包主要是用来划分独立模块，类的包路径建议根据项目模块名称来命名。如下：

格式：包前缀+ 相关模块名称+ 业务类型

案例：com.qqs.system.[action/service/model/service.impl]

一般可将类的包路径存放于源包路径下，源包路径主要是为了更好体现项目模块的独立性。如下：