当前位置 博文首页 > 宏然依依的博客:【Java学习】怎么理解Java 中的文档注释?

    宏然依依的博客:【Java学习】怎么理解Java 中的文档注释?

    作者:[db:作者] 时间:2021-07-19 16:34

    在此之前,我们应该知道,在阅读项目代码中, 常常会有注释部分来帮助我们来理解代码功能模块,那在java学习中,你对Java的注释了解多少?今天我们在这里来总结了解一下。
    Java注释分类:
    1.//
    2./* /
    3.第三种被称作说明注释,它以/
    * 开始,以 */结束。
    注意:说明注释允许在程序中嵌入关于程序的信息,可以使用javadoc工具软件来生成信息,并输出到HTML文件中。

    在使用javadoc工具软件之前,我们得明白一些javadoc 标签;
    javadoc 标签
    @author :标识一个类的作者
    @deprecated: 指名一个过期的类或成员
    {@docRoot}: 指明当前文档根目录的路径
    @exception :标志一个类抛出的异常
    {@inheritDoc} :从直接父类继承的注释
    {@link} :插入一个到另一个主题的链接
    {@linkplain} :插入一个到另一个主题的链接,但是该链接显示纯文本字体
    @param :说明一个方法的参数
    @return :说明返回值类型
    @see: 指定一个到另一个主题的链接
    @serial :说明一个序列化属性
    @serialData :说明通过writeObject( ) 和 writeExternal( )方法写的数据
    @serialField :说明一个ObjectStreamField组件
    @since :标记当引入一个特定的变化时
    @throws :和 @exception标签一样.
    {@value}: 显示常量的值,该常量必须是static属性。
    @version: 指定类的版本
    备注:加粗的为常用的Javadoc标签;

    关于文档注释

    在开始的/**之后,第一行或几行是关于类、变量和方法的主要描述.
    之后,你可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*).
    多个相同类型的标签应该放成一组。例如,如果你有三个@see标签,可以将它们一个接一个的放在一起。
    下面是一个类的说明注释的示例:

    /*** This class draws a bar chart.
    * @author Zara Ali
    * @version 1.2
    */
    

    了解了这些,在阅读java工程项目代码中,就不会太难了,好了,今天对java文档注释就总结到了这里。

    代码记心中,知识记脑海,运用知识创造代码,加油吧!

    cs