栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Java注释

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Java注释

三种注释方式

        (1)前两种分别是// 和,

        (2)第三种被称作说明注释,它以结束

说明注释 1. 简介

        说明注释允许你在程序中嵌入关于程序的信息。你可以使用javadoc工具软件来生成信息,并输出到HTML文件中。

        说明注释,使你能更加方便地记录你的程序信息

2. javadoc标签

        javadoc工具软件识别以下标签:

        @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

@link注释

        在代码中编写注释是一种非常好的习惯,有的时候一个类或者方法会被多次使用,每次使用的时候都要重复写对应的注释就很麻烦,如果使用@link 标签, 可以只写一次, 其他处直接引用即可。

1. 语法

        {@link 类名#方法名}        (其中,大括号、@link 是必须要有的)

2. 三种使用方法

(1)如果单纯指向某个类 则可以省略方法,例如:

        {@link 类名}

(2)指向当前类中的方法,例如:

        {@link 类名#方法名}或者{@link #方法名}

(3)指向其他类下的方法,例如:

        {@link 类名#方法名}

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/281737.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号