代码规范和团队协作规章

好的开发习惯，可以帮助我们和团队走的更远

代码规范

Java规范：

一、自定义标识符

1、标识符的细节

① 标识符的组成元素是由字母（a-zA-Z）、数字(0-9) 、下划线(_)、美元符号($)

② 标识符不能以数字开头

③ 标识符是严格区分大小写的

④ 标识符的长度是没有长度限制的

⑤ 标识符的命名一般要有意义（见名知意）

⑥ 关键字、保留字不能用于自定义的标识符

2、标识符的规范

① 类名和接口名单词的首字母大写，其他单词小写（SunTime）

② 变量名与方法名首单词全部小写，其他单词首字母大写，其他单词都要小写 [ doCook() ]

③ 包名全部单词小写

④ 常量全部单词大写，单词与单词之间使用下划线分隔（UP_LENGTH）

3、判断一下那些是符合的标识符

① 12abc_ [不合法。数字不能开头]

② _12abc [合法]

③ $ab12# [不合法。#号不属于标识符组成元素]

④ abc@123 [不合法。@号不属于标识符组成元素]

二、注释

1、注释的类别

第一种： 单行注释 // 注释的内容

第二种： 多行注释 /* 注释的内容 */

第三种： 文档注释 /** 注释的内容 */ 文档注释也是一个多行注释

注意：单行注释可以嵌套使用，多行注释是不能嵌套使用的

2、多行注释与文档注释的区别

多行注释的内容不能用于生成一个开发者文档，而文档注释的内容可以生产一个开发者文档。

3、使用javadoc开发工具即可生成一个开发者文档

使用格式：javadoc -d 指定存放文档的路径 -version –author(可选) 目标文件

注意细节：

① 如果一个类需要使用javadoc工具生成一个软件的开发者文档，那么该类必须使用public修饰

② 文档注释注释的内容一般都是位于类或者方法的上面的

③ &#