文本注释

Java中的注释

• 单行注释      // 注释内容
• 多行注释      /注释内容/
• 文档注释
  /**
  *注释内容
  *注释内容
  */

JavaDoc

• JavaDoc用来生成自己的API文档

参数信息

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

文件注释在doc窗口生成

1. 从需要生成文件注释的文件进入dos窗口
2. 输入命令'Javadoc -encoding UTF-8 -charset UTF-8 Doc.java'

IDEA生成文件注释

1. 在IDEA工具栏tools中，打开选项Generate JavaDoc；
2. 配置参数
   (1) 选中Directory;
   (2) output directory中选中需要需要生成文件注释的文件；
   (3) Locale输入zh_CN;
   (4) Other command输入-encoding UTF-8 -charset UTF-8;