JavaDoc和变量的命名规范

参数信息

• @author 作者名
• @version 版本号
• @since 知名需要最早使用的jdk版本
• @param 参数名
• @return 返回值情况
• @throws 异常抛出情况

代码示例

/**
 * @author ang
 * @version 1.0
 * @since 1.8
 */

/**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public  String test(String name) throws Exception{
        return name;
    }

使用命令行生成JavaDoc文档

• 进入java文件所在位置后输入如下命令

  • encoding UTF-8,让编码以UTF-8进行编码
  • charset UTF-8,设置字符集为UTF-8避免中文乱码
  • Doc.java是要编辑的文档名
    
    javadoc -encoding UTF-8 -charset UTF-8 Doc.java

• 生成如下文件

• 打开index.html,如图

使用IDEA生成JavaDoc文档

• 在工具栏点击生成JavaDoc

• 进行如下设置

  • 输出目录自定义
  • 区域设置成zh_CN
  • 其他命令行实参规定编码和字符集以避免中文乱码
    

• 点击生成即可

变量的命名规范

• 所有变量、方法、类名：见名知意
• 类成员变量：首字母小写和驼峰原则：monthSalary
• 局部变量：首字母小写和驼峰原则
• 常量：大写字母和下划线：MAX_VALUE
• 类名：首字母大写和驼峰原则：Man,GoodMan
• 方法名：首字母小写和驼峰原则：run(),runRun()

原文地址：http://www.cnblogs.com/studydreamlife/p/16862118.html