Java注释

最新推荐文章于 2025-09-07 11:24:32 发布

原创最新推荐文章于 2025-09-07 11:24:32 发布 · 136 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

Java注释专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍了Java中使用的文档注释及其应用场景。包括@author用于标识作者，@deprecated用于标记过时的方法或类，@exception说明可能抛出的异常，@inheritDoc继承父类注释，@link和@linkplain创建链接，@param解释方法参数，@return描述返回值，@see提供额外参考资料，@serial说明序列化属性等。

Java_注释

单行注释

//这是一个单行注释

多行注释

/*多行注释
多行注释
多行注释
*/

文档注释

（java特有）拿给其他人用时，方便他人理解。
java常用的文档注释标签
1、@author：标识一个类的作者
实例： @author 薛
2、@deprecated：指名一个过期的类或成员
实例： @deprecated description
3、@exception：标志一个类抛出的异常
实例：@exception exception-name explanation
4、{@inheritDoc}：从直接父类继承的注释
实例：Inherits a comment from the immediate surperclass.
5、{@link}：插入一个到另一个主题的链接
实例：{@link name text}
6、{@linkplain}：插入一个到另一个主题的链接，但是该链接显示纯文本字体
实例：Inserts an in-line link to another topic.
7、@param：说明一个方法的参数
实例：@param parameter-name explanation
8、@return：说明返回值类型
实例：@return explanation
9、@see：指定一个到另一个主题的链接
实例：@see anchor
10、@serial：说明一个序列化属性