Java的注释，标识符、标识符的命名规范

Java的注释

Java注释有三种：单行注释、多行注释、文档注释。

单行注释

一般用来注释局部变量。
示例：

//单行注释，年龄等于18
int age = 18;

多行注释

可用来注释文件头、算法实现、方法中的复杂代码块、修改记录等。
示例：

/*
 多行注释，说明方法的内部实现，复杂逻辑等
*/
public void show() {

}

文档注释

可用来注释类、接口、静态方法、成员方法、静态变量、成员变量、常量等。
示例1（方法注释）：

/**
 * 方法说明
 * 
 * @param args 入参说明
 * @return int 返回值说明
 * @throws Exception 抛出异常信息说明
 */
public int getValue(String args) throw Exception {

}

示例2（类注释）：

/**
 * 类说明
 * 
 * @author username 作者信息（必须）
 * @since 创建日期（根据公司规范不同，也有采用 @Date 或者 @date 的形式，个人建议还是采用小写）
 * @version v1.0 版本号
 */
public class Person {

}

示例3（属性注释）：

/**
 * 属性的描述
 */
private String username;

Java的标识符

凡是可以由自己命名的地方都称为标识符（修饰符）。
例：项目名，包名，类名，方法名
标识符命名规定：

• 只能以字母、数字、下划线、美元符组成
• 不能以数字开头
• 不能使用关键字或者保留字作为标识符

Java的命名规范

1. 项目名全部小写
   示例：my-first-java-project
2. 包名全部小写
   示例：com.java.demo
3. 类名首字母大写，若类名由多个单词构成，每个单词首字母大写，即驼峰命名法
   示例：MyJavaApplication
4. 变量名、方法名首字母小写，若其由多个单词构成，每个单词首字母大写，即小驼峰命名法
   示例：myJavaMethod
5. 常量名全部大写
   示例：MY_JAVA_CONSTANT
6. 以上所有命名遵循以下规则：
   • 名称只能由字母、数字、下划线、美元符组成
   • 不能以数字开头
   • 不能是Java的关键字和保留字
   • 严禁使用汉字和拼音
   • 长度理论上没有限制，但最好见名知意，反映其作用