Javadoc(文档注释)详解!!!

Javadoc(文档注释)详解!!!

Javadoc(文档注释)

​ 在之前提到过java有三行注释,而关于文档注释,在这里做一个详细的讲解

1.java文档注释的作用

​ 文档注释只放在类、接口、成员变量、方法之前,以/*开始,/结束,我们可以通过javadoc生产API文档,来对类、成员变量、方法进行说明。API是我们可以直接调用,只需要了解其功能和使用方法,就可以直接拿上去使用。像,java中的Date,math等等。Api在java中就是一个类。

2.几种常用的Javadoc标签

Javadoc 工具可以识别文档注释中的一些特殊标签,这些标签一般以@开头,后跟一个指定的名字,有的也以{@开头,以}结束。Javadoc 可以识别的标签如下表所示:

标签 作用
@author 标识一个类的作者
@param 方法的参数
@return 标明返回值类型,一般用于方法注释,不能出现再构造方法中
{@value} 显示常量的值,该常量必须是 static 属性。
@since 版本号,标明从哪个版本起开始有这个函数
@version 指定类的版本
@exception 可能抛出异常的说明,一般用于方法注释
@throws 也是可能抛出异常的说明
@serial 说明一个序列化属性
@serialData 说明通过 writeObject() 和 writeExternal() 方法写的数据
@serialField 说明一个 ObjectStreamField 组件

3.java生产doc文档

​ 我们使用的函数都是之前的前辈们,创建的,那么如何去生产doc文档呢?主要有两种方法

使用dos命令生产doc文档

Ⅰ.首先我们创建一个Doc.java的文件,也就是类,再给文件添加一些注释,写两个方法

代码如下:

public class Doc {
    String name;
    int n=5;
    int m=6;
    /**
     * @author ling
     * @version jdk1.8.0
     * @since 1.0
     * @param n
     * @param m
     * @return
     */
    public int add(int n, int m) {
        int sum = 0;
        if (n<m){
            m--;
        }else {
            System.out.println(n);
        }
        return sum;
    }
    public String student(String name) throws  Exception{
        name="ling";
        return name;
    }

}

Ⅱ.查看当前文件所在的目录

鼠标右键点击该文件,然后open in Explorer打开文件路径,然后使用dos命令切换到该目录

Ⅲ.切换到该目录

如果需要切换盘符,就在前面加上/d,否则则不用加

cd /d 该文件所在目录

确保该文件目录下有刚才所写的Doc.java文件

Ⅳ.执行javadoc命令

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

encoding和后面的charest都是指定编码,把编码类型设置为utf-8,以防出错。

Ⅴ.可以看到在该文件夹下生成了好多文件,打开index.html就可以查看生成的doc文档了

Ⅵ.查看html文件

点击dao


利用开发工具生成javadoc文档,我使用的是Intellij Idea生成的doc文档,也可以使用eclipse!

1.第一步

2.配置生成文件

(1).选择是整个项目还是模块还是单个文件

(2).文档输出路径

(3).Locale 选择地区,这个决定了文档的语言,中文就是zh_CN

(4).传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api
3.配置完点击OK即可

可以看到文档已生成

hmoban主题是根据ripro二开的主题,极致后台体验,无插件,集成会员系统
自学咖网 » Javadoc(文档注释)详解!!!