ToB企服应用市场:ToB评测及商务社交产业平台

标题: java_3种注释语句 [打印本页]

作者: 立山    时间: 2023-8-10 21:11
标题: java_3种注释语句
1.内容

解释// 内容单行注释/* 内容 */多行注释/*** 内容 */文档注释2.多行注释 与 文档注释的区别

多行注释:


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


3.生成步骤





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.05.规范

类,方法的注释,要用javadoc的方式写,为了在生成的API文档上 说明此类或方法的用途

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!




欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4