java注释(comment)

风萧萧路漫漫      2022-05-07     560

关键词:

                   

//单行注释

/**/多行注释

单行注释和多行注释,注释了的内容不参与编译。

编译以后生成的.class结尾的字节码文件中不包含注释掉的信息

多行注释不可以嵌套使用

还可以用来调试代码,把不确定哪个地方有没有写错的时候,注释掉看还报不报错

 

 

只能提取文档注释

javadoc -d 文件夹名称 -author -version 源文件名称.java

 

 

/** */文档注释(Java特有的),可以使用javadoc工具软件来生成信息,并输出到HTML文件中

@author 标识一个类的作者
@deprecated 指名一个过期的类或成员
{@docRoot} 指明当前文档根目录的路径
@exception 标志一个类抛出的异常
{@inheritDoc} 从直接父类继承的注释
{@link} 插入一个到另一个主题的链接
{@linkplain} 插入一个到另一个主题的链接,但是该链接显示纯文本字体
@param 说明一个方法的参数
@return 说明返回值类型
@see 指定一个到另一个主题的链接
@serial 说明一个序列化属性
@serialData 说明通过writeObject( ) 和 writeExternal( )方法写的数据
@serialField 说明一个ObjectStreamField组件
@since 标记当引入一个特定的变化时
@throws 和 @exception标签一样.
{@value} 显示常量的值,该常量必须是static属性。
@version 指定类的版本

来源于菜鸟教程

在文件头部添加:

/*
 * <p>项目名称: ${project_name} </p> 
 * <p>文件名称: ${file_name} </p> 
 * <p>描述: [类型描述] </p>
 * <p>创建时间: ${date} </p>
 * <p>公司信息: ************公司 *********部</p> 
 * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a>
 * @version v1.0
 * @update [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]
 */

方法:

/**
 * @Title:${enclosing_method}
 * @Description: [功能描述]
 * @Param: ${tags}
 * @Return: ${return_type}
 * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a>
 * @CreateDate: ${date} ${time}</p> 
 * @update: [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]     
 */

getter

/**
 * 获取  ${bare_field_name}
 */

setter

/**
 * 设置   ${bare_field_name} 
 * (${param})${field}
 */

 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

 

注释(comments)

注释(comments)注释是不会执行的,只是给人看的要养成写注释的好习惯要规范 1.单行注释(linecomment)//注释内容2.多行注释(blockcomment)/**注释内容*/3.文档注释(JavaDoc)与多行注释在第一行多了一个*/***@author作者*@version版本号*@since最... 查看详情

halcon算子翻译——comment

名称comment -为程序添加一行注释。用法comment(::Comment:)描述comment给程序中添加一行注释。作为参数值,即作为注释,允许所有的字符。如果使用算子窗口输入注释,并且注释行参数中有换行符,则每个文本行都插入一条注释... 查看详情

使用 sed 使所有注释保持一致

】使用sed使所有注释保持一致【英文标题】:usesedtomakeallcommentsconsistent【发布时间】:2021-01-1315:11:23【问题描述】:我的文件包含不均匀的cmets://file1.php//Week4//Quiz//coment3//comment4//comment5//comment6%comment7%comment8%comment9#comment10#comment1... 查看详情

comment类型(注释)

<!DOCTYPEhtml><html> <head> <metacharset="UTF-8"> <title>Comment类型</title> </head> <body> <divid="myDiv"><!--Acomment--></div> < 查看详情

PHP:显示 HTML 注释

】PHP:显示HTML注释【英文标题】:PHP:showHTMLcomments【发布时间】:2022-01-0414:38:20【问题描述】:考虑以下PHP函数:functionshow_html_comment($comment)echo\'<!--\'.$comment.\'-->\';此函数显示HTMLcmets。但是如果$comment里面有一个HTML注释呢?$... 查看详情

java注释

设置注释模板的入口:Window->Preference->Java->CodeStyle->CodeTemplate然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:文件(Files)注释标签:/**   *@Title:${file_name} *@Package${package_name}&nbs 查看详情

vim注释插件nerd_commenter

下载vim注释插件NERD_commenter[[email protected] ~]# mkdir -pv ~/.vim/plugin/[[email protected] ~]# curl https://raw.githubusercontent.com/scrooloose/nerdcommente 查看详情

plsql建表如何添加注释

plsql在oracle中创建表时添加注释使用comment字段。例如有以下表: CREATETABLEt1(id varchar2(32)primarykey,nameVARCHAR2(32),ageVARCHAR2(32))添加表注释的命令为:COMMENT ON tablet1IS '个人信息';添加字段注释命令为:commentoncolumnt1... 查看详情

drupalalter注释表单

...onofHOOK_theme().*/functionTHEMENAME_theme(){returnarray('comment_form'=>array('arguments'=>array('form'=>NULL),),);} //themethecommentformfunctionTHEMENAME_comment_form($form){//Makethetext-areasmaller.$form['comment_filter'&#... 查看详情

java基础语法

4.1添加注释comment单行注释多行注释文档注释//这是单行注释的文字/*这是多行注释的文字这是多行注释的文字这是多行注释的文字*//**这是文档注释的文字@authorAdministrator*/注释:就是对代码的解释和说明。其目的是让人们能够更... 查看详情

javadoc注释

...ow-->Preferences-->Java-->CodeStyle-->CodeTemplates,对右侧Comments选项中具体的注释信息进行编辑即可。可勾选上自动添加注释信息,在生成java文件时便会自动生成注释,当然也可以手动插入注释。 java注释快捷键:Ctrl+Shift+C... 查看详情

如何用自定义 <comment> 元素替换 HTML 注释

】如何用自定义<comment>元素替换HTML注释【英文标题】:HowtoreplaceHTMLcommentswithcustom<comment>elements【发布时间】:2015-04-1917:58:03【问题描述】:我正在使用Python中的BeautifulSoup将大量HTML文件大量转换为XML。示例HTML文件如下... 查看详情

jsp语法

 ①注释元素(CommentsElements)1.<!--comment[<%=expression>]-->标准的HTML注释。JSP容器会将该注释发往客户端浏览器,但不在浏览器中显示,可以在HTML源文件中查看。comment-注释内容expression-可选的java表达式,JSP容器会对表达式... 查看详情

获取表注释,字段注释

1.获取当前用户的表注释select*fromuser_tab_comments;2.获取当前用户所有字段注释select*fromuser_col_comments  查看详情

如何在 MySQL 中添加注释?

】如何在MySQL中添加注释?【英文标题】:HowcanIaddcommentsinMySQL?【发布时间】:2012-02-2407:12:28【问题描述】:我想在SQL代码中添加注释。我怎样才能做到这一点?我正在使用MySQL。【问题讨论】:【参考方案1】:几种方式:#Comment... 查看详情

如何找到源代码中的所有注释?

...如何找到源代码中的所有注释?【英文标题】:Howtofindallcommentsinthesourcecode?【发布时间】:2011-10-0204:12:50【问题描述】:cmets有两种风格,C风格和C++风格,如何识别?/*comments*///comments我可以随意使用任何方法和第三库。【问题... 查看详情

雪花中列注释的最大长度

...雪花中列注释的最大长度【英文标题】:MaximumlengthofcolumncommentsinSnowflake【发布时间】:2021-03-2919:57:44【问题描述】:雪花中的一列评论的最大长度是多少?文档站点:https://docs.snowflake.com/en/sql-reference/sql/comment.html语法:COMMENT[IFE... 查看详情

latex的注释

在LaTex中的注释有以下3种1.用%注释一行文字,在%后的文字都不予编译;2.用iffalse....fi包含一段文字,被包含的文字被注释掉了;3.用egin{comment}...end{comment}包含被注释的文字,但是需要在引言区包括相应的宏包,即usepackage{verbatim}. 查看详情