JavaDoc学习

JavaDoc

有一说一，这节课听的迷迷糊糊的，有点听不懂，暂时先做个笔记，希望学习了后面的知识可以把这些全都弄懂吧

• javadoc命令是用来生成自己ApI文档的

• 参数信息

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

• JavaDoc在文档注释中写

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

• Show in Explorer(在文件夹打开)

• 使用cmd生成文档

  •  javadoc -encoding(设置编码) UTF-8 -charset(设置字符集) UTF-8 Doc.java
    

  • 通过命令行生成Doc文档：javadoc 参数 Java文件

  • 使用IDEA生成Doc文档：

    • 在IDEA中的Tools标题栏中找到GenerateJavaDoc…
      

    • 在打开的窗口中，Output directory中选择路径，Command Lline arguments中输入-encoding UTF-8 -charset UFT-8（设置为中文防止乱码）
      

    • 最后点击Generate即可生成JavaDoc文档