JavaDoc生成文档

JavaDoc生成文档实例

1. 编写代码

   package com.ping.base;
   
   /**
    * @author pqf
    * @version 1.0
    * @since 1.8
    */
   public class Doc {
   
       String name;
   
       /**
        * @param name
        * @return
        * @throws Exception
        * @author pqf
        */
   
       public String test(String name) throws Exception {
           return name;
       }
   }
   
   

2. 打开类所在文件夹并进入cmd输入命令:javadoc -encoding UTF-8 -charset UTF-8 Doc.java

   其中参数：encoding（编码）、charset （字符集编码）是为了解决中文乱码问题

   

3. 运行成功后文件夹中会生成一些文件，打开index.html

   

4. 进入主页，文档生成成功