项目规范文档

git书写规范

一般情况下，提交 GIT 时的注释可以分成几类，可以用几个动词开始：
add ( 新加入的需求 )
fix ( 修复 bug )
update ( 完成的任务，或者由于第三方模块变化而做的变化 )
change（代码审查）
merge（代码合并）
尽量将注释缩减为一句话，不要包含详细的内容。eg：merge:代码合并 | change:lambda表达式优化

git学习地址：git-scm

java类命名规范

• 由于Java面向对象编程的特性, 在命名时应尽量选择名词

• 驼峰命名法（Camel-Case）: 当变量名或函式名是由一个或多个单字连结在一起，而构成的唯一识别字时，首字母以小写开头，每个单词首字母大写（第一个单词除外）。

java变量命名

• 一般要求
  
  • 选择有意义的名字，能快速地传达该变量的用途。
  • 参照java驼峰命名法，首字母以小写开头，每个单词首字母大写（第一个单词除外）。

• 实际应用

  • 变量命名采用基本结构为typeVariableName，使用3字符前缀来表示数据类型。例如，定义一个整形变量：intDocCount，其中int表明数据类型，后面为表意的英文名，每个单词首字母大写。
  • 数据类型或对象类型

• 变量使用技巧：

  • 在一段函数中不使用同一个变量表示前后意义不同的两个数值。
  • 除非是在循环中，否则一般不推荐使用单个字母作为变量名，i、j、k等只作为小型循环的循环索引变量。
  • 避免用Flag来命名状态变量。
  • 用Is来命名逻辑变量，如：blnFileIsFound。通过这种给布尔变量肯定形式的命名方式，使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。
  • 如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性。例如，如果在代码的某些区域中使用intCnt，而在另一些区域中又使用intCount，就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。
• 1、做数组用时，再加前缀-a,如字符串数组：astr，2、自定义类型的变量可以采用本身的名称，把首字母改为小写。3、采用名称要能代表在方法中的意义。如果员工列表：employeeLis

数据类型或对象类型	变量前缀
byte	bye
char	chr
float	flt
boolean	bln
Integer/int	int
short	sht
Long/long	lng
Double/double	dbl
String	str

* 静态变量
* 选择有意义的名字，能快速地传达该变量的用途。
* 参照java驼峰命名法，采用全部大写的形式来书写，对于采用多词合成的变量采用“_”来连接各单词。如：USER_LIST
* 方法的命名
* 一般要求
* 选择有意义的名字，能快速地传达该方法的用途。
* 参照java驼峰命名法，首字母以小写开头，每个单词首字母大写（第一个单词除外）。
* 实际应用
* 方法表示一种行为，它代表一种动作，最好是一个动词或者动词词组或者第一个单词为一个动词。
* 属性方法：以get/set开头，其后跟字段名称，字段名称首字母大写。如：getUserName()
* 数据层方法：只能以insert（插入）,delete（删除）,update（更新）,select（查找）,count（统计）开头，其他层方法避免以这个5个单词开头，以免造成误解。
* 服务层方法，根据方法的行为命名，只描述方法的意义，而不采用方法的目的命名。比如系统的添加新用户，用户可以前台注册，也可以管理员后台添加，方法会被重用，所以最好不要用使用register，采用add会更好写。避免使用与web层相关的方法。
* Web层方法最好是贴近web的语言，如register，login，logout等方法。

注释的书写规范 （Javadoc）

• Java除了可以采用我们常见的注释方式（//、/* /）之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc注释，以/*开头，而以*/结束， Javadoc 注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。 推荐使用。
• Javadoc注释主要涉及范围：类、属性、方法。