Java标识符规范

标识符

标识符是我们给变量、类、方法等取的名字。
取名规则：
1.标识符中可以包含字母（中文）、下划线、美元符 $、数字，不能包含其他符号
2.标识符不能以数字开头
3.标识符不能是关键字
命名建议：
1.类名，每个单词的首字母大写（大驼峰）例如：MyFirstApp，TestApp等
2.方法名，首字母小写，后面每个单词开头大写 例如：getHttpMessage()， localValue等
3.变量名，和方法名规则一样。
4.常量命名全部大写，每个单词间下划线分开
5.字定义的标识符在命名时，使用尽量完整的单词组合来表示。

注释方法

注释为了增强代码的可读性，不参与编译运行，但是非常的重要，不注释经常自己写过的代码回头看，看不懂。

单行注释://注释的内容

多行注释:/*注释的内容*/

文档注释:/**注释的内容*/
（常见于方法和类之上描述方法和类的作用，可以被javadoc工具解析，生成一套以网页文件形式体现的程序说明文档）

⛔注意：文档注释和多行注释不能嵌套使用，多行注释和文档注释可以嵌套单行注释。
如何用从源代码中提取出文件注释？

/**
 * @version 1.0
 * @author Mr.li
 */

/**
*这是一个测试类
*/
public class Demo{
   
    /**
     * 用于测试的main方法
     */
    public  static void main(String[] args){
        System.out.println("Hello world");
    }

    /**
     * 用与测试的方法
     */
    public static void testMethod(){

    }
}

cmd命令窗口使用：javadoc -d 文件夹名 -author -version -encoding UTF-8 -charset UTF-8 文件名.java
注意：文档注释一般写在类、方法、接口、构造器、成员字段前面，写在方法体内是无效的文档注释。


1.内容准确，注释内容能准确表达代码意思，并在代码修改后及时更新
2.篇幅合理，内容不要太简短，也不要长篇大论
3.国内公司一般采用中文注释

Java关键字