项目开发相关规范

目录规范

目录规范——在开发中整体文件夹组织结构。

1.Requirement——需求文档文件夹

2.Design——设计文档文件夹

3.Test——集成测试，系统测试，测试报告，测试清单文件夹

4.Deployment——发布部署的文件夹

5.Study——预研，学习资料的文件夹

6.Src——源码文件夹

7.Help——帮助文档文件夹

基本命名规范

1.变量使用驼峰法的规则命名，要加入前缀m，如：mUserNum;

2.常量使用全大写字母标识，单词间用下划线隔开，如：USER_NAME；

3.类名使用首字母大写，如：UserName；

4.方法名使用驼峰法的规则命名，不用加入前缀，如：getUserName；

5.接口名使用首字母大写；

 

 

包名命名规范

1.包名一律首字母大写, 少用缩写；

2.包名结构：[项目名].[基本模块名].[具体模块名]

    如：com.example.View.UserModule

 

注释

文件，类或接口注释

Ÿ所有的源文件都应该在开头有一个注释，其中列出文件的作者、时间、功能描述以及创建、修改记录

 

/**

 *

 * @Description功能描述

 *

 * 版本号   作者   日期   相关修改

 * 1.0   linbin  2014-5-4 创建

 *

 * @authorlinbin

 *2014-5-4

 */

方法注释

Ÿ所有的方法都应该在开头有一个注释，其中列出功能描述，所使用的参数说明，返回值说明

/**

  *  功能描述

  * @param参数说明

  * @return返回值说明

  */

  

注释格式设置方法：

右键项目->Properties->Java CodeStyle->Comments 然后选择对应项，进行模板的设置