文件夹规范

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

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  创建

 *

 * @author linbin

 *2014-5-4

 */

方法凝视

全部的方法都应该在开头有一个凝视，当中列出功能描写叙述，所使用的參数说明，返回值说明

/**

  *  功能描写叙述

  * @param參数说明

  * @return返回值说明

  */

  

凝视格式设置方法：

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