使用文档注释时,需要在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述 。
之后,可以包含一个或多个何种各样的@ 标签 。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*) 。多个相同类型的标签应该放成一组 。
2、【多行注释】注释的也是方法或类,言下之意就是一次性的将程序中的多行代码注释掉,但多行注释的内容不能用于生成一个开发者文档 。
3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档,而文档注释的内容可以生产一个开发者文档 。
扩展资料
java常用的文档注释标签
1、@author:标识一个类的作者
实例: @authordescription
2、@deprecated:指名一个过期的类或成员
实例: @deprecateddescription
3、@exception:标志一个类抛出的异常
实例:@exceptionexception-nameexplanation
4、{@inheritDoc}:从直接父类继承的注释
实例:Inheritsacommentfromtheimmediatesurperclass.
5、{@link}:插入一个到另一个主题的链接
实例:{@linknametext}
6、{@linkplain}:插入一个到另一个主题的链接,但是该链接显示纯文本字体
实例:Insertsanin-linelinktoanothertopic.
7、@param:说明一个方法的参数
实例:@paramparameter-nameexplanation
8、@return:说明返回值类型
实例:@returnexplanation
9、@see:指定一个到另一个主题的链接
实例:@seeanchor
10、@serial:说明一个序列化属性
实例:@serialdescription
参考资料:百度百科-java注释
关于java怎么注释多行代码和java程序中多行注释符的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息 , 记得收藏关注本站 。
推荐阅读
- u盘一样文件怎么批量删除,u盘里怎么批量删除
- flutter与原生通信,flutter与原生通信map
- 公众号注册审核多长时间,注册微信公众号要审核多久
- win7游戏桌面不能存档,win7游戏存档在哪个文件夹
- php数据流生成图片 php读取图片流输出到html
- 定做安卓刷机包,安卓刷机包通用版
- 南京网络软件代理商有哪些,南京有哪些软件开发公司
- 云秀直播录屏怎么录屏的,云秀直播录屏怎么录屏的声音
- python内部绘图函数 python绘图总结