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

    Java注释:

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

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

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

    jsp注释:

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

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

    mysql注释:

    #这是注释: 单行注释

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

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

     

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

    万次阅读 多人点赞 2018-06-21 15:10:50
    说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 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系统。每周都有技术文章推送,包括原创技术干货,以及技术工作的心得分享。扫描下方关注。


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

    万次阅读 2019-05-24 00:48:57
    C#的三种注释方法 第一种: 常规的双斜杠: // 例如 //这是一个注释 第二种: /* 注释内容, 可以随意换行 */ 第三种:代码块上面的三斜杠注释,用来解释代码块的具体含义,便于后来者理解,例如: /// ///管理层的...

    C#的三种注释方法
    第一种:
    常规的双斜杠: //
    例如 :

    //这是一个注释
    

    第二种:

    /*
    注释内容,
    可以随意换行
    */
    

    第三种:代码块上面的三斜杠注释,用来解释代码块的具体含义,便于后来者理解,例如:

             /// <summary>
            ///管理层的工资
            /// </summary>
            /// <param name="money">工资</param>
            /// <param name="fh">分红</param>
            /// <returns></returns>
            public double Calculation(double money)
            {
                int fh = 10000;
                return money + fh;
            }
    

    当然,如果想要选中的行快速注释,除了第一第二中方法外,我们可以使用快捷键注释,这样就能在需要注释大量代码行的时候节省时间。
    选中需要注释的代码,按ctrl+k+c当然也可以快速取消注释,快捷键为:ctrl+k+u

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

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

    展开全文
  • 各种编程语言的注释形式

    千次阅读 2017-10-09 19:25:15
    注释://这里是注释注释:/*这里是注释*/ Java 行注释://这里是注释注释:/*这里是注释*/ HTML 块注释: CSS 块注释:/*这里是注释*/ JavaScript 行注释://这里是注释注释:/*这里是注释*/ XML 块...
  • 软件编写规范(注释篇)

    千次阅读 2017-06-25 11:35:43
    说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语 言必须准确、易懂、简洁。 2、说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部...
  • 注释和注解的区别

    千次阅读 2018-09-18 16:34:39
    注解 :参与代码编译,以@开头的。它是给应用程序看的,单独使用注解毫无意义,一定 要跟工具一起使用,这个所谓的工具实际就是能读懂注解的应用程序 。...注释 :对代码没有影响。对代码起到解释、说明的作用; ...
  • 申请软件著作权时需要清除代码中的注释,可以通过word和Notepad++组合操作来快速的完成 1。使用word的插入文件功能合并多个源代码文件,操作方法为:新打开1个word文件,在“插入”标签栏下找到“对象”点击右边的...
  • 注释 、CSS/JS //注释 和 /*.....*/ 注释 <!-- -->是HTML的注释标签,使用 < 和 > 是符合HTML标签语法规则的。/* */是CSS的注释标签 /* */(注释代码块)、//(注释单行)是JS的注释标签。 两种注释...
  • MySQL 添加注释(comment)

    万次阅读 多人点赞 2016-10-01 19:18:03
    在MySQL数据库中, 字段或列的注释是用属性comment来添加。创建新表的脚本中, 可在字段定义脚本中添加comment属性来添加注释。示例代码如下:create table test( id int not null default 0 comment '用户id' ) ...
  • Java注释中文乱码问题

    万次阅读 2016-08-14 21:28:51
    当我们打开一个项目时,经常会遇到中文乱码的问题, 如图中/** * ����ԱϵͳController�� * @author Administrator * */ @Controller @RequestMapping("/admin/system") public class ...
  • IDEA类和方法注释模板设置(非常详细)

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

    万次下载 热门讨论 2014-03-10 15:21:33
    包含LINUX内核同步、信号、内存、调度、文件系统、网络系统、时钟等部分的源码注释。前后历时三年,算是干货。
  • idea设置代码注释

    万次阅读 2018-07-01 09:51:44
    人工智能,零基础入门!http://www.captainbed.net/inner 1、 2、 3、aplpy ---> OK 4、
  • Linux2.6.24内核注释

    千次下载 热门讨论 2014-05-29 22:42:05
    所有注释都是中文,您可以与标准2.6.24内核进行比较,看看具体的注释内容。 针对2.6.24注释的时间比较短,内容不多,抱歉,请不要拍砖。更多的注释是针对linux2.6.11.12内核的,您可以通过...
  • 优秀的程序员真的不写注释吗?

    万次阅读 多人点赞 2020-05-11 07:02:23
    我在很多地方看到这样一个观点,“请停止写注释,因为只有烂的代码才需要注释。”这个观点非常巧妙,它让我想起了孟子的一句话,“杨氏为我,是无君也;墨氏兼爱,是无父也。无父无君,是禽兽也。” 动不动就骂别人...
  • 我从网上查了一堆解决办法,但是都是2017年以前的解决方案,并且都是针对于source insight 3.5及以下版本的,目前SI软件版本都到4.0了,应该有新方法出现了。 ————————————————————————...
  • VS 注释多行与取消多行注释快捷键

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

    万次阅读 多人点赞 2018-09-05 10:05:24
    注释 CTRL+K+C 取消注释 CTRL+K+U
  • Golang学习笔记 11.godoc代码文档注释

    万次阅读 2020-09-09 09:20:33
    godoc代码文档注释 大纲 文档规则 示例 事先准备 查看文档 总结 视频地址:https://www.bilibili.com/video/BV14a4y177XG?p=12 文档规则 godoc支持package、const、var和func这些代码生成文档,而且只会对...

空空如也

1 2 3 4 5 ... 20
收藏数 1,763,035
精华内容 705,214
关键字:

注释