JavaDoc

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

  • 在线API帮助文档 (需要记住，以后需要会用到)

    1. 浏览器搜索：JDK帮助文档
    2. 看到Orakle官方的"Java SE 文档 - API和文档"字样的打开
    3. 选择自己所使用的JDK版本即可

    

  • 生成自己的API文档

    1. 在JDKA中右键咱们的Doc类代码文件 > 打开于 > 资源管理器

       

    2. 在资源管理器导航栏中最前面输入"cmd"打开命令窗口

       

    3. 在命令窗口中输入 javadoc -encoding UTF-8 -charset UFT-8 Doc.java 回车即可

       • javadoc：生成文档

       • -encoding UTF-8 -charset UFT-8：此命令用于防止文档中出现中文导致乱码，优化文档编码

       • Doc.java：引用生成文档的Java文件

       

    4. 完成以上全部步骤之后回到"Doc.java"目录中会发现多了很多陌生的文件，其中"index.html"就是它的API文档。打开就是咱们Doc编写的API文档全部内容了

       

       

       

  • 代码格式说明

    javadoc 参数 Java文件
    

• 参数信息

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