java学习笔记——javaDOC生成文档

使用方法

• 使用/**再按回车（在idea下），来生成DOC文档，具体形式如下

/**
 * @author zhengxiangwen
 * @version 1.0
 * @since 1.8
 * @param 参数
 * @return null
 * @throws 异常抛出情况
 */

参数信息

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

生成JavaDOC文件

• 通过在命令行输入以下命令生成DOC文件

    javadoc -encoding UTF-8 -charset UTF-8 文件名.java
  

• 其中 -encoding UTF-8 -charset UTF-8 这两句命令是为了防止中文乱码的。