Java文档注释

作者: JWking | 来源:发表于2019-07-25 17:39 被阅读0次

    Java 支持三种注释方式。前两种分别是 // 和 /* */,第三种被称作说明注释,以 /** 开始,以 */结束。说明注释允许在程序中嵌入关于程序的信息。可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中,更加方便的记录程序信息。

重点讲解说明注释,在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。之后,可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*),多个相同类型的标签应该放成一组。

下图是javadoc可识别的标签

javadoc 标签

javadoc 输出

    javadoc 工具将 Java 程序的源代码作为输入,输出一些包含程序注释的HTML文件,每一个类的信息将在独自的HTML文件里。

javadoc 也可以输出继承的树形结构和索引。

由于 javadoc 的实现不同,工作也可能不同,需要检查你的 Java 开发系统的版本等细节,选择合适的 Javadoc 版本。

配置默认说明注释的模板:

在IDEA主界面点击File,选择setting进入到如下面板

第1步,选择左边栏的File and Code Templates;

第2步,选择右边栏的includes;

第3步,选择File Header;

第4步,在右边空白部分新建自己的说明注释内容;

最后,apply完成。

说明注释模板

通过javadoc输出说明注释文件:

在IDEA主界面选择Tools下的Generate JavaDoc

按照以上操作打开如下面板后

第1步,选择需要生成 JavaDoc 的源代码对象,一般以模块(Module)为主,必要时可以单独选择必要的 Java 源代码文件;

第2步,选择输出目录;

第3步,将生成的 JavaDoc 设置为中文;

第4步,-encoding UTF-8 -charset UTF-8 -windowtitle "你的文档在浏览器窗口标题栏显示的内容" -link http://docs.Oracle.com/javase/7/docs/api

配置javadoc

执行生成javadoc文件之后,浏览器自动打开已输出的注释文档

浏览器显示注释文档

相关文章

  • Java基础复习

    注释 Java语言的注释有三种 单行注释 多行注释 文档注释 CSDN中这篇文章详细描述了java文档注释的各种用...

  • 【Java补充】 Java文档注释

    Java文档注释 4.9 文档注释 运行javadoc可以生成HTML文档。 以专用的定界符 /**开始的注释,可...

  • Java中的注释、关键字、标识符

    Java中的注释 1. 单行注释 // 2. 多行注释 /* */ 3. 文档注释 /** */ Java中的关键...

  • kotlin精讲-第2章(4)注释和异常

    难度指数:★☆☆☆☆ 惊喜指数:★★☆☆☆ 注释 同Java,Kotlin注释也是分为单行注释、多行注释、文档注释...

  • java中的注释(Comment)

    java中的注释分为三种 单行注释 多行注释 文档注释 文档注释,会被编译,单行和多行注释不会被编译 例如这个文件...

  • Groovy基本语法

    官方文档 注释(Comments) 和Java一样,支持单行(使用//)、多行(/* */)和文档注释(使用/**...

  • 注释

    注释三种 单行注释 // 开头 多行注释 /* 开头,*/ 结尾 文档注释 /** 开头,*/ 结尾 Java编译...

  • 3.注释(Comment)

    含义:用于注解说明解释程序的文字就是注释 1.Java中的注释类型 单行注释 多行注释 文档注释(java特有) ...

  • java文档注释

    Dos下编译生成javaAPI文档javadoc -d 文档存放目录 -author -version 源文件名....

  • Java 文档注释

    Java 支持三种注释方式。前两种分别是 // 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束...

网友评论

    本文标题:Java文档注释

    本文链接:https://www.haomeiwen.com/subject/aoghrctx.html