变量的命名规范和JavaDoc命令

变量的命名规范

• 所有变量、方法、类名：见名知意
• 类成员变量：首字母小写和驼峰原则：monthSalary 除了第一个单词外，后面的单词首字母大写
• 局部变量：首字母小写和驼峰原则
• 常量：大写字母和下划线：MAX_VALUE
• 类别：首字母大写和驼峰原则
• 方法名：首字母小写和驼峰原则：run() runRun()

#JavaDoc命令

• javadoc命令是用来生成自己的API文档的
• 参数信息
  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

/**
 * @author Xionganyuan
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
     return name;
    }
}