Java基础：JavaDoc

JavaDoc

用于生成自己的API文档

参数信息

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

生成文档

  1. 命令行

    • 在cmd移动到该目录
    • 执行命令
    javadoc java文件
//中间加参数
//javadoc -encoding UTF-8 -charset UTF-8 Doc.java

  2. idea生成

    • Tools -> Generate JavaDoc

    • 在弹出界面中选择生成整个文件的Doc文档或单个Doc文件

    • 选择输出路径（Output directory）

    • Locale: zh_CN

    • Other command line arguments:(传入doc的参数)

    -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/8/docs/api
posted @ 2022-03-07 15:42  chachan53  阅读(47)  评论(0)    收藏  举报