0
点赞
收藏
分享

微信扫一扫

注释(单行注释,多行注释,文档注释)

小月亮06 2022-04-05 阅读 188

注释

  1. 注释是写给我们自己看的,它不会被执行

  2. 单行注释:// (阔以注释一行文字)

  3. 多行注释:/* 注释 */ (阔以注释一段文字)

  4. 文档注释:/** */ (在程序中嵌入关于程序的信息)

    在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。

    之后,你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*).

    多个相同类型的标签应该放成一组。例如,如果你有三个 @author 标签,可以将它们一个接一个的放在一起。

    标签描述示例
    @author标识一个类的作者@author description
    @deprecated指名一个过期的类或成员@deprecated description
    {@docRoot}指明当前文档根目录的路径Directory Path
    @exception标志一个类抛出的异常@exception exception-name explanation
    {@inheritDoc}从直接父类继承的注释Inherits a comment from the immediate surperclass.
    {@link}插入一个到另一个主题的链接{@link name text}
    {@linkplain}插入一个到另一个主题的链接,但是该链接显示纯文本字体Inserts an in-line link to another topic.
    @param说明一个方法的参数@param parameter-name explanation
    @return说明返回值类型@return explanation
    @see指定一个到另一个主题的链接@see anchor
    @serial说明一个序列化属性@serial description
    @serialData说明通过writeObject( ) 和 writeExternal( )方法写的数据@serialData description
    @serialField说明一个ObjectStreamField组件@serialField name type description
    @since标记当引入一个特定的变化时@since release
    @throws和 @exception标签一样.The @throws tag has the same meaning as the @exception tag.
    {@value}显示常量的值,该常量必须是static属性。Displays the value of a constant, which must be a static field.
    @version指定类的版本@version info

实例:

/**
*这个类没一点用哦
*@author longbro
*@version 6.6
*/
举报

相关推荐

0 条评论