java_3种注释语句


1.内容

解释
// 内容 单行注释
/* 内容 */ 多行注释
/*** 内容 */ 文档注释

2.多行注释 与 文档注释的区别

多行注释:

img
img


文档注释:JDK提供工具javadoc解析 注释的内容,为生成API文档做准备

img
img


3.生成步骤

img

img

img

img


4.javadoc标签

标签 描述 示例
@author 作者 @author liudelantu
@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 1.0

5.规范

类,方法的注释,要用javadoc的方式写,为了在生成的API文档上 说明此类或方法的用途文章来源地址https://uudwc.com/A/zkpbY

原文地址:https://www.cnblogs.com/liudelantu/p/17621575.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请联系站长进行投诉反馈,一经查实,立即删除!

h
上一篇 2023年09月25日 13:19
什么是Progressive Web App(PWA)?它们有哪些特点?
下一篇 2023年09月25日 13:26