前言

我们开发的过程里，常常会去查阅各类文档，文档上面有着极为仔细的注释，有些还存在示例，注释是一个文件的灵魂，开发了这么长时间，你会运用文档注释吗？接下来会开展java文档注释的介绍。

初始注释

其这样具备的作用是，于生成说明文件之际有所用，是那供使用者，或者供阅读者，能够快速去熟悉所进行的设置，同时也是为了让自己往后看到之时，能够一下子就明白其中情况的作用。

单行注释

    //main方法
    public static void main(String[] args) {
        System.out.println("掘金 - 代码不止，掘金不停");
    }
复制代码

多行注释

    //main方法
    public static void main(String[] args) {
        /*
        以下执行将输出
        【掘金 - 代码不止，掘金不停】
         */
        System.out.println("掘金 - 代码不止，掘金不停");
    }
复制代码

文档注释

    /**
     * @MethodName: testJavaDoc
     * @Description: 测试多行文本输出
     * @param
     * @Return: void
     * @Author: JavaZhan @公众号:Java全栈架构师
     * @Date: 2020/6/13
     **/
    public static  void testJavaDoc(){
        System.out.println("掘金 - 代码不止，掘金不停");
        System.out.println("作者：小阿杰");
        System.out.println("主页地址：https://juejin.cn/user/2040300414187416/posts");
        System.out.println("欢迎关注交流学习！");
    }
复制代码

是否会感到十分好奇，@、@、@param、@除去文章当中所出现的标签之外，还有哪些属于文档注释的标签，究竟是哪些标签能够被使用，下面为大家进行了一番汇总。

注释常用的标签

标签

描述

示例

@

一个类或者方法的的作者

@

@

一个过期的类或成员

@

@Date

创建日期

@Date: 2020/6/13

{@}

当前文档根目录的路径

Path

@

抛出的异常

@ -name

{@}

从直接父类继承的注释

a from the .

{@link}

插入一个到另一个主题的链接

{@link name }

{@}

插入一个到另一个主题的链接，但是该链接显示纯文本字体

an in-line link to topic.

@param

方法的参数

@param -name

@

返回值类型

@

@see

指定一个到另一个主题的链接

@see

@

一个序列化属性

@

@

说明通过( ) 和 ( )方法写的数据

@

@

说明一个组件

@ name type

@since

标记当引入一个特定的变化时

@since

@

和 @标签一样，抛出异常

具有相同于该@标签的那个@标签，有着相同的情况，存在相同的情形，呈现相同的样子，具备相同的状况。

{@value}

显示常量的值，该常量必须是属性。

具有这样一种情况，即存在某个值，这个值是a，而a必须是一个领域。

@

指定类的版本

@ info

@

方法名称

@

在/**之后，第一行属于关于类、变量以及方法的主要描述。注释文档能够依据标签intellij idea java，为类、方法、接口甚至枚举等等提供使得开发人员以及使用人员易于阅读的文本内容。

快速开始生成文档

本次生成文档借助生成，这是Sun公司所给予的一项技术，它从程序源代码里抽取类、方法、成员等注释，进而形成一与源代码配套的API帮助文档，也就是说，只要于编写程序之际以一套特定的标签作注释intellij idea java，在程序编写完毕后，通过它便能够同时形成程序的开发文档了。

那个被用于生成自身 API 文档的命令，其使用方式是，要通过命令行在目标文件所处的目录输入加上文件名.java，命令具体如下：

javadoc ****.java
复制代码

进入目录

如下图，进入将要执行生成的文件，输入： ****.java

执行 Tests.java，生成如下文件和文件夹。

点击其中index.html，已经进入到文档页面。

结语

如有侵权请联系删除！