编程规范及注释习惯

良好的命名习惯：

1. 标识符：但凡是起名字的地方，这个名字统称为 “ 标识符 ”

标识符要求【语法规则，必须遵守】

1 ） java 中的标识符只能以数字，字母，下划线、$组成 ，其中数字不能开始

2 ） java 中的标识符严格区分大小写

3 ） java 中的标识符没有长度的限制

4 ）不能使用 java 中的关键字、保留字（ goto ， const ）、特殊字符（ true ， false ， null ）命名

5 ） java 中可以使用汉字命名，但是不建议使用

6）命名尽量望文生义

7）包名全部小写

8） 类名每一个单词的首字母都大写（这种命名方式称为 “ 驼峰命名法 ” ）

9） 函数名、方法名、变量名 第一个单词首字母小写，其他单词首字母大写（遵守驼峰命名法）

10）常量名大写（常量！！！）PI=3.14

注释习惯

作用： 1. 解释说明 2. 提高代码的可读性 3. 使程序中的部分代码失效

单行注释： // 只能写一行注释内容

多行注释： /*

可以写 n 行注释内容

*/

注意： 单行注释里不能嵌套多行注释 ， 多行注释内容里可以嵌套单行注释

3. 文档注释

/**

可以写 n 行内容

使用： javadoc -d doc 源文件名 .java

注意： 文档注释仅对 公开类 和 函数 进行解释说明