Java 从入门到放弃06 - 《JavaDoc命令——文档注释》

JavaDoc命令——文档注释

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

package com.utils;

/**
 * @author 2018X5zzt
 * @version 1.0
 */

public class Doc {
    String name;

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

• 之后在该目录下终端中执行javadoc命令

   javadoc -encoding UTF-8 -charset UTF-8
  

• 使用IDEA也可以生成JavaDoc文档！

• 生成后的情况如下：
  

  • 点进index.html文件可以查看信息
    

  • 点击类名可以查看信息