注释_注释快捷键 - CSDN
精华内容
参与话题
  • Java注释: //:行注释,单选注释。用于某行代码后面 /**/:块注释。//的升级版,用来注释多行代码,也可以写多行注释 /***/:javadoc注释。同上,但是能写入javadoc文档说明,用来生成HTML格式的代码报告,所以...

    Java注释:

    //:行注释,单选注释。用于某行代码后面

    /**/:块注释。//的升级版,用来注释多行代码,也可以写多行注释

    /***/:javadoc注释。同上,但是能写入javadoc文档说明,用来生成HTML格式的代码报告,所以注释文档必须写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。

    jsp注释:

    <!-- 注释内容 --> : HTML注释。内容可见,出现在生成的HTML代码中,浏览器会忽略此注释

    <%-- 注释内容 --%> : JSP页面注释。标记的内容客户端查看源码时是完全看不到的。JSP注释只在JSP代码中可见。
    <% // 注释内容 %> : Java注释。单行注释,显示在servlet代码中,不显示在响应中
    <% /* 注释内容 */ %> : Java注释。多行注释,同上

    mysql注释:

    #这是注释: 单行注释

    --  这是注释:同上,--后面是有空格的

    /* 这是注释 */ :多行注释

     

    展开全文
  • 【代码规范】常见注释规范

    万次阅读 多人点赞 2018-06-26 16:28:53
    说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 2.文件注释:文件注释写入文件头部。说明:以/* 开始示例:/ ** 文件名:[文件名]* ...

    文章来源:公众号-智能化IT系统。


    1.在有处理逻辑的代码中,源程序有效注释量必须在20%以上。

    说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。

     

    2.文件注释:文件注释写入文件头部。

    说明:以/* 开始

    示例:

    / *

    文件名:[文件名]

    作者:〈版权〉

    描述:〈描述〉

    修改人:〈修改人〉

    修改时间:YYYY-MM-DD

     * 修改内容:〈修改内容〉
     
     */

     

    说明:每次修改后在文件头部写明修改信息。

    示例:

    / *

    文件名:LogManager.java

    版权:Copyright 2000-2001 Huawei Tech. Co. Ltd.  All Rights Reserved.

    描述: WIN V200R002 WEBSMAP 通用日志系统

    修改人:张三

    修改时间:2001-02-16

    修改内容:新增

    修改人:李四

    修改时间:2001-02-26

    修改内容:。。。。。。

    修改人:王五

    修改时间:2001-03-25

    修改内容:。。。。。。

     */



     

    3.类和接口的注释:该注释放在class定义之前,usingpackage关键字之后。

    示例:

    package com. websmap.comm;

    /**

     * 注释内容

     */
     public class CommManager

     

    4.类和接口的注释内容:类的注释主要是一句话功能简述、功能详细描述,说明:可根据需要列出:版本号、生成日期、作者、内容、功能、与其它类的关系等。

    格式:

    / *

     * 〈一句话功能简述〉

    〈功能详细描述〉

    * @author [作者]

    * @version [版本号, YYYY-MM-DD]

    * @see [相关类/方法]

    * @since [产品/模块版本]

    * @deprecated

    */

    说明:描述部分说明该类或者接口的功能、作用、使用方法和注意事项,每次修改后增加作者和更新版本号和日期,@since 表示从那个版本开始就有这个类或者接口,@deprecated 表示不建议使用该类或者接口。

    示例:

    / *

    * LogManager 类集中控制对日志读写的操作。

    *全部为静态变量和静态方法,对外提供统一接口。分配对应日志类型的读写器,读取或写入符合条件的日志纪录。

    * @author 张三,李四,王五

    * @version 1.2, 2001-03-25

    * @see LogIteraotor

    * @see BasicLog

    * @since CommonLog1.0

    */


    5.
    类属性、公有和保护方法注释:写在类属性、公有和保护方法上面。用//来注释,需要对齐被注释代码。

    示例:

    / /注释内容

    private  String logType

     

    6.成员变量注释内容:成员变量的意义、目的、功能,可能被用到的地方。用//来注释,需要对齐被注释代码


    7.公有和保护方法注释内容:列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。
    格式:

    / **

    *〈一句话功能简述〉

    *〈功能详细描述〉

    * @param [参数1] [参数1说明]

    * @param [参数2] [参数2说明]

    * @return [返回类型说明]

    * @exception/throws [违例类型] [违例说明]

    * @see [类、类#方法、类#成员]

     * @deprecated

    */

    说明:@since 表示从那个版本开始就有这个方法;@exceptionthrows 列出可能出现的异常;@deprecated 表示不建议使用该方法。

     

    8.对于方法内部用throw语句抛出的异常,必须在方法的注释中标明,对于所调用的其他方法所抛出的异常,选择主要的在注释中说明。对于非RuntimeException ,即throws子句声明会抛出的异常,必须在方法的注释中标明。

    说明:

    异常注释用@exception@throws表示,在JavaDoc中两者等价,但推荐用@exception标注Runtime 异常,@throws标注非Runtime 异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。

     

    9.注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

     

    10.注释的排版,按照上述示例来展示。


    11.注释应该放在被注释的代码前面,分行展示,但中间不留空行。


    12.对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。

    说明:分支语句往往是程序实现某一特定功能的关键。

     

    13.边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

     

    14.注释的内容要清楚、明了,含义准确,防止注释二义性。说明:错误的注释不但无益反而有害。

     

    15.避免在注释中使用缩写,特别是不常用缩写。说明:在使用缩写时或之前,应对缩写进行必要的说明。



    公众号-智能化IT系统。每周都有技术文章推送,包括原创技术干货,以及技术工作的心得分享。扫描下方关注。


    展开全文
  • 优秀的程序员真的不写注释吗?

    万次阅读 多人点赞 2020-05-11 07:02:23
    我在很多地方看到这样一个观点,“请停止写注释,因为只有烂的代码才需要注释。”这个观点非常巧妙,它让我想起了孟子的一句话,“杨氏为我,是无君也;墨氏兼爱,是无父也。无父无君,是禽兽也。” 动不动就骂别人...

    我在很多地方看到这样一个观点,“请停止写注释,因为只有烂的代码才需要注释。”这个观点非常巧妙,它让我想起了孟子的一句话,“杨氏为我,是无君也;墨氏兼爱,是无父也。无父无君,是禽兽也。”

    动不动就骂别人是“禽兽”,我总觉得有点不妥,这很不符合孟子的浩然之气啊。有些大牛也有孟子这样的觉悟,如果有人要他给自己的代码加上注释,就好像是对他的一种侮辱:“我的代码写得这么优雅,你难道看不懂吗?注释是多余的!”

    我必须得承认,每个程序员都应该有一颗追求“优雅”的心,力争自己的代码更易阅读和理解——不只是针对机器,还有我们程序员同行。但不是每个程序员在一开始都能写出“高标准”的代码的,就好像不是所有君王和百姓都能搞清楚孟子的治国齐家理念的。

    在我刚回洛阳的那段时间,过得非常痛苦。因为我刚接手了别人留下的一个项目,关于大宗期货交易的。后端代码是用 Java 写的,但有很多 bug 在里面,动不动就资金结算失败,甚至内存溢出,要解决这些问题,只有一个办法,就是彻底搞懂这些代码。

    否则,根本无从下手。这就好像,你和朋友开车出去自驾游,去很远很远的地方,朋友开累了,需要休息,这时候,如果你没考过驾照,那就抓瞎了,只能把车停路边,等朋友的疲劳消退了,才能继续上路。

    我就抓瞎了。凭良心说,前同事留下的代码是精彩绝伦的,如果换做是我来写,真不一定能写得出来。毕竟大宗期货交易本身还是有点难度的,需要竞价撮合,这个业务理解起来比股票还要复杂些。

    股票涨了就赚,跌了就亏。期货不同的,买涨能赚,买跌也能赚。不过业务上的复杂还是次要的,重要的是代码里的注释非常稀有,就好像詹姆斯高斯林头上的发丝一样稀有。

    况且,国内程序员的英语功底你懂的,变量、方法、类、接口、枚举的命名无法做到真正意义上的名如其意。再加上,有些方法的行数多达三四百行,从头看到尾,看得只想捶自己。

    没办法,我的解决办法就是,看懂一行就加一行注释,毕竟注释总比代码要容易理解啊。就好像,我们在调用一个不熟悉的 API 时,只要代码的文档说清楚它是干嘛的,我们就可以用,就敢用,至于实现的细节,暂时没有理解也没关系。

    差不多花了两个月的时间(非常漫长、非常煎熬)吧,我总算是把项目中核心的代码给研究清楚了。搞清楚之后,那些之前怎么改都改不掉的 bug 也就迎刃而解了。

    这也就是为什么,我倡导大家去读源码的一部分原因了,除了学习,读源码是解决 bug 的杀手锏。要读懂源码,注释是必不可少的。不信,你看看 Java 的源码,每个变量、每个方法、每个类,注释都非常详细,详细到你替源码的作者感到心累。

    在我看来,Java 源码的作者绝对是这个世界上最优秀的程序员,连他们都写注释,那些声称“请停止写注释”的号召者是不是要啪啪啪地打脸,直到打肿为止。

    不要怀疑自己,写注释并不会证明你的代码就是烂代码。我相信,你应该买过电子产品,比如说鼠标、键盘、耳机、手机等等,所有的产品包装里除了产品本身,使用说明书是必不可少的。我就问一句,“手机没有使用说明书,咱这些后浪还能不会用?”

    写注释不是我们的错,软件本来就是复杂的。尤其是我们这些英语不是主力语言的人来说,注释显得尤为重要。我可能属于记忆力不好的那一种,隔个十天半个月,再去回头看那些我自己敲的代码,有时候真有点见着陌生人的感觉:“这代码是我写的吗?怎么有点面生啊?”

    大部分人写的代码都要升级重构,对吧?不论是语言本身版本的升级,还是我们自身能力的成长。假如在升级重构的时候,没有这些注释的帮助,真有点爬泰山的感觉,累啊,亲。

    再者说,大牛也不敢保证自己的代码是没有问题的,对吧?但注释是不会骗人的,它的意义是明确的。你可能会忘记代码是干嘛的,但我敢保证,注释能够唤醒你的记忆。

    写出好的、有意义的注释其实是有难度的,就像写代码一样。在追求卓越的路上,代码和注释其实是相辅相成的。注释会让你的代码更易阅读,代码会让你的注释更富有逻辑。

    即便是你的代码已经优雅到不需要注释,那只是在你的层面上。对于你的同事,你代码后来的负责者,就不一定了。所见略同的英雄并不会很多,你以为很优雅的代码没准在别人眼里就是一坨垃圾,而你的注释很可能会帮助别人“恍然大悟”,明白代码的意义。乖乖地写注释吧,对你对别人都有好处。

    另外,我想说一句,注释就好像是代码的一个蓝图,也或者是对代码的一个总结。在你写代码之前,脑子里肯定要想清楚你要实现什么,怎么实现,把这些作为注释写下来绝对可以帮助你写出更优雅的代码。在代码写完之后,通过注释进行总结,还能对代码进行一些升华,没准还能在总结的过程中想到更好的代码方案。

    我还见到有大牛信誓旦旦地说,写注释就好像是给不会游泳的人扔一个救生圈,他永远也学不会游泳。咋眼一看,这句话说得很有道理,对吧?在大牛们看来,要让一个新人快速成长,最好的办法就是把没有注释的代码扔给他看。

    纯属扯淡,恐怕这个新人没入门就放弃了吧?我已经三十一岁了,不,我已经十八岁了,还不会游泳呢?别听那些大牛们的鬼话,我就不信,他自己没写过注释。

    总之一点,注释并不会妨碍你写出优雅简洁的代码,它只是程序固有的一部分而已

    如果觉得文章对你有点帮助,请微信搜索「 沉默王二 」第一时间阅读。本文已收录 GitHub,传送门~ ,里面更有大厂面试完整考点,欢迎 Star。

    我是沉默王二,一枚有颜值却靠才华苟且的程序员。关注即可提升学习效率,别忘了三连啊,点赞、收藏、留言,我不挑,嘻嘻

    展开全文
  • 注释的内容不会出现在字节码中,即java编译器编译时会跳过注释语句,在java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。 1,单行注释 单行注释是以“//”开头的后面的内容就是注释。 2,多行注释 ...

    注释就是我们在写程序的时候会经常的加入注释,第一方便我们的阅读,第二用来提高程序的可读性。java语言允许程序员在程序中写上一些说明性的文字,这些说明性的文字就是注释。注释的内容不会出现在字节码中,即java编译器编译时会跳过注释语句,在java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。
    1,单行注释
    单行注释是以“//”开头的后面的内容就是注释。
    2,多行注释
    多行注释是以“/”开头和以“/”结尾的,之间的内容均为注释,我们也可以使用多行注释作为行内注释。但是使用时要注意,多行注释不能嵌套使用。
    3,文档注释
    文档注释是以“/**”开头以“*/”结尾注视中包含这一些说明性的文字及一些javaDoc标签(后期写项目时,可以生成项目的API)
    写注释是一个非常非常好的习惯,建议以后写完每一个方法每一个类上面都写上注释,告诉别人这个方法这个类是干什么的。即使你写的方法名称和类名称写的非常好,可能别人通过这个英文名称就知道是干嘛的了但是仍然建议加上注释,这是一个非常好的习惯,建议你们从一开始就养成这个非常好的习惯。

    展开全文
  • c#之 三种注释方法以及快捷键

    万次阅读 2019-05-29 19:41:46
    C#的三种注释方法 第一种: 常规的双斜杠: // 例如 //这是一个注释 第二种: /* 注释内容, 可以随意换行 */ 第三种:代码块上面的三斜杠注释,用来解释代码块的具体含义,便于后来者理解,例如: /// ///管理层的...
  • 基本概念:注解,顾名思义,就是对某一事物进行添加注释说明,会存放一些信息,这些信息可能对以后某个时段来说是很有用处的。Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。Java 语言中的...
  • 解决:xml文件单行注释、多行注释问题

    万次阅读 多人点赞 2019-09-18 16:10:03
    【解决:xml文件中的单释、多行注释问题】 第一种(单行): <!-- 注释内容 --> 第二种(多行): <!-- 注释内容(无其他注释符) ...
  • 注释和注解的区别

    千次阅读 2018-09-18 16:34:39
    注解 :参与代码编译,以@开头的。它是给应用程序看的,单独使用注解毫无意义,一定 要跟工具一起使用,这个所谓的工具实际就是能读懂注解的应用程序 。...注释 :对代码没有影响。对代码起到解释、说明的作用; ...
  • 为程序添加注释可以用来解释程序某些部分的作用和功能,提高程序的可读性。除此之外,注释也是调试程序的重要方式。在某些时候,我们不希望编译、执行程序中的某些代码,这时就可以将这些代码注释掉。 当然,添加...
  • Java注释中文乱码问题

    万次阅读 2016-08-14 21:28:51
    当我们打开一个项目时,经常会遇到中文乱码的问题, 如图中/** * ����ԱϵͳController�� * @author Administrator * */ @Controller @RequestMapping("/admin/system") public class ...
  • 单行注释以"#"开头的行就是注释,会被解释器忽略。#-------------------------------------------- # 这是一个注释 # author:菜鸟教程 # site:www.runoob.com # slogan:学的不仅是技术,更是梦想! #--...
  • linux2.6.1内核源码注释

    万次下载 热门讨论 2020-07-30 23:32:28
    包含LINUX内核同步、信号、内存、调度、文件系统、网络系统、时钟等部分的源码注释。前后历时三年,算是干货。
  • IDEA类和方法注释模板设置(非常详细)

    万次阅读 多人点赞 2018-10-22 15:58:03
    IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。 这里设置的注释模板采用Eclipse的格式,...
  • idea设置代码注释

    万次阅读 2019-12-22 14:31:19
    人工智能,零基础入门!http://www.captainbed.net/inner 1、 2、 3、aplpy ---> OK 4、
  • Linux2.6.24内核注释

    千次下载 热门讨论 2020-07-30 23:32:27
    所有注释都是中文,您可以与标准2.6.24内核进行比较,看看具体的注释内容。 针对2.6.24注释的时间比较短,内容不多,抱歉,请不要拍砖。更多的注释是针对linux2.6.11.12内核的,您可以通过...
  • MySQL 添加注释(comment)

    万次阅读 多人点赞 2020-07-16 08:27:09
    在MySQL数据库中, 字段或列的注释是用属性comment来添加。创建新表的脚本中, 可在字段定义脚本中添加comment属性来添加注释。示例代码如下:create table test( id int not null default 0 comment '用户id' ) ...
  • 我从网上查了一堆解决办法,但是都是2017年以前的解决方案,并且都是针对于source insight 3.5及以下版本的,目前SI软件版本都到4.0了,应该有新方法出现了。 ————————————————————————...
  • VS 注释多行与取消多行注释快捷键

    万次阅读 多人点赞 2019-11-15 10:51:04
    最近在使用VS2010开发ASP.NET,突然发现想全部注释时找不到注释的快捷键,网上查了下,原来很简单,只是需要使用组合键。 注释: 先CTRL+K,然后CTRL+C 取消注释:先CTRL+K,然后CTRL+U ...
  • VScode注释与取消注释快捷键

    万次阅读 多人点赞 2019-06-11 14:24:12
    注释 CTRL+K+C 取消注释 CTRL+K+U
  • 代码注释如此沙雕,会玩还是你们程序员!

    万次阅读 多人点赞 2020-06-05 11:13:12
    某站后端代码被“开源”,同时刷遍全网的,还有代码里的那些神注释。 我们这才知道,原来程序员个个都是段子手;这么多年来,我们也走过了他们的无数套路… 首先,产品经理,是永远永远吐槽不完的!网友的评论也非常...
1 2 3 4 5 ... 20
收藏数 1,736,965
精华内容 694,786
关键字:

注释