JavaDoc

JavaDoc

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

• 参数信息

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

jdk帮助文档：https://www.oracle.com/cn/java/technologies/java-se-api-doc.html

package com.example.operator;

/**
 * @author tan
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;


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

    /**
     * 通过命令行生成JavaDoc文档：先打开要生成的类的文件夹位置,点击搜索栏把之前路径删除，写上cmd回车，然后
     * 写 javadoc encoding UTF-8 charset UTF-8 Doc.java(要生成的类名xxx.java)回车就生成了
     */

    //作业：学会查找使用IDEA生成JavaDoc文档！（百度一搜有很多）   java开发就是 面向百度编程！


}

要学会面向百度编程！

这是生成的javadoc文档