JavaDoc

JavaDoc

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

  1. 将当前类在文件夹中打开，右击当前类，选中open in explorer

     

  2. 通过资源管理器的地址栏进入cmd

  3. 执行 javadoc -encoding UTF-8 -charset UTF-8 Doc.java
     

  4. 在生成的文件中找到 index.html 并打开

• 参数信息

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

package com.jiang.base;
/**
 * @author ImaShark
 * @version 1.0
 * @since 1.8
 */
public class Doc {
     
    String name;

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

拓展

• 使用IDEA生成JavaDoc文档