使用IDEA生成JavaDoc

1|0使用IDEA生成JavaDoc

目录

• 使用IDEA生成JavaDoc
  • 文档注释参数信息
  • 关于JavaDoc的IDEA参数设置

1|1文档注释参数信息

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

示例代码：

/**
 * @author  DT
 * @version  1.0
 * @since  8.0
 */

public class Doc {
    String name;

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

1|2关于JavaDoc的IDEA参数设置

IDEA-工具(Tool)-生成JavaDoc

• 选择需要生成JavaDoc范围

• 选择生成JavaDoc的文件输出目录

• 填入其他命令行参数

  -encoding UTF-8 -charset UTF-8

  

设置完后点击确认，则会立即使用IDEA在输出目录下生成JavaDoc，可以用浏览器打开查看相关信息

__EOF__

本文作者：userName
本文链接：https://www.cnblogs.com/dt746294093/p/14558876.html
关于博主：评论和私信会在第一时间回复。或者直接私信我。
版权声明：本博客所有文章除特别声明外，均采用 BY-NC-SA 许可协议。转载请注明出处！
声援博主：如果您觉得文章对您有帮助，可以点击文章右下角【推荐】一下。您的鼓励是博主的最大动力！