天天看点

Java自学|Doc

Java自学|Doc

文档注释

根据前面讲到的文档注释即/**加上回车

/**
 * @author Alan_Lowe
 */
//整个类的文档注释
public class selfStudy {
    public static void main(String[] args) {
        int x = 1;
    }

    int a = 1;

    /**
     * @param a
     * @return
     */
    //func方法的文档注释
    String func(int a){

        return "";
    }
}      

可以对类进行文档注释,也可以对方法进行文档注释,并且方法的注释中,参数和返回都是自动生成的。

使用IEDA生成javadoc

  1. 点击Tools找到如下按钮兵点击
Java自学|Doc
  1. 进行如下设置:
Java自学|Doc

点击ok即可在Doc保存的位置找到。

Java自学|Doc

可以看到已经多了一堆东西。

点击index.html:

Java自学|Doc

世上没有白走的路,每一步都算数!