15.JavaDoc

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

参数信息

  • @author 作者名
  • @version 版本号
  • @since 指明需要早期使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况
/**
 *@author 枭紫兮
 *@version 1.0
 *@since 1.8
 */
public class Doc {

    String name;

    /**
     * @author 枭紫兮
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;

        //生成JavaDoc文件:
        //①通过命令行实现:javadoc 参数 Java文件   如:E:\CODE\JavaSE\基础语法\src\com\teamscorpionhome\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java
        //②通过IDEA产生JavaDoc文档    参考:https://blog.csdn.net/qq_42498502/article/details/90078972

    }

}
posted @ 2021-08-16 01:18  枭紫兮  阅读(33)  评论(0)    收藏  举报