学习笔记---javaDoc

Doc文档注释

图片来自B站狂神说

通过命令行生成文档

• 格式
  javadoc 参数（-encoding utf-8 -charset utf-8
  ） java文件

通过IDEA生成文档

• Tools -->Generate javadoc -->other command …中写入-encoding utf-8 -charset utf-8

package operator;

/**
 * @author gdutlog
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    
    
    String name;

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

生成结果：