JavaDoc文档

JDK帮助文档

在线链接：Overview (Java Platform SE 8 ) (oracle.com)

• javadoc命令是用来生成自己的API文档的
• 参数信息
  • @author 作者
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • throws 异常抛出情况

课堂代码练习

package com.tea.base;
/**
 * @author teatea
 * @version 1.0
 * @since 1.8
 */
public class doc {

    String name;

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

通过命令行javadoc参数java文件

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

作业：学会查找使用IDEA生成JavaDoc文档

参考作者：https://blog.csdn.net/weixin_42140580/article/details/89635775