JavaDoc

JavaDoc

简介

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了

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

API（Application Programming Interface，应用程序接口）是一些预先定义的函数，或指软件系统不同组成部分衔接的约定

参数信息

1. @author 作者名
2. @version 版本号
3. @since 指名需要最早使用的jdk
4. @param 参数名
5. @return 返回值
6. @throws 异常抛出情况

生成JavaDoc

方式一:通过命令行生成JavaDoc

1. 首先编写一个多行注释注释类

package com.basics;

/**
 * @author shuai
 * @version 1.0
 * @since 1.0
 */
public class Demo7 {
    public String name;

    /**
     * @param name
     * @throws Exception
     * @return
     */
    public String test(String name) throws Exception{
        name="shaui";
        return name;
    }
}

2. 找到需要生成doc的目录,在目录前面加上cmd+空格,进入操作系统
   

3. -encoding UTF-8 -charset UTF-8 这个可能编译时会出现不是中文,设置编译出来时中文

   encoding 编码 charset 字符集 UTF-8 中文

   语法: javadoc 文件名.java
   

4. 这样就生成javadoc成功了

5. 找到刚刚需要生成doc的目录,就会发现下面多了一堆东西
   

方式二:通过idea生成JavaDoc

1. 首先编写一个多行注释注释类

package com.basics;

/**
 * @author shuai
 * @version 1.0
 * @since 1.0
 */
public class Demo7 {
    public String name;

    /**
     * @param name
     * @throws Exception
     * @return
     */
    public String test(String name) throws Exception{
        name="shaui";
        return name;
    }
}

2. 点击idea目录的tools选项,然后点击Generate JavaDoc

3. 1:指定需要生成doc的文件
   2:设置编译出文件的位置
   3:设置地区位置 zh_CN 表示中国
   4:传入JavaDoc的参数 -encoding UTF-8 -charset UTF-8 这个可能编译时会出现不是中文,设置编译出来时中文
   

4. 出现这个就是在执行,并且执行成功

   

5. 由于idea会自动帮我们打开index.html,如果没有,找到自己刚刚编译出文件的位置,找到index.html打开即可