javaDoc生成文档（待补充）

javaDoc

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

• 参数信息

  • @author 作者名

  • @version 版本号

  • @since 指明需要最早使用的jdk版本

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

package javaSE.base;
​
/**
 * @author lshyd
 * @version 1.0
 * @since 18
 */
​
public class Doc {
    String name;
​
    /**
     * @author lshyd
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name ;
    }
}

生成dos文档教学

https://blog.csdn.net/weixin_42140580/article/details/89635775