精华内容
下载资源
问答
  • 谈一谈修改代码加注释的原则和方法
    千次阅读
    2019-01-04 10:42:40

    暮鼓集    行走集

    原作于2008年06月01日,软件部培训稿

    我们修改代码时少不了要加一些注释,这基本的原则是“言简意赅”,只要做到大家能看懂,在版本比较工具(BC及VSS)中能一目了然,这就可以了。

    下面介绍一些方法供大家参考:

    为某一项目或者某一MACRO配置而添加的代码

    #if defined(__PROJECT_A__) // Add by XXX, YYYY-MM-DD
    ...Your codes
    #elif defined(__PROJECT_B__) // Add by YYY, YYYY-MM-DD
    ...Other codes
    #else
    ...Orginal codes
    #endif  
    

    为修改某一Bug而添加并通用于各项目的代码

    #if 1 // Add by XXX, YYYY-MM-DD
    ...Your codes
    #else
    ...Original codes
    #endif  
    

    如果需要说明是为了什么而修改,也可将注释单列一行。

    // Add by XXX, YYYY-MM-DD
    // ... Description
    // ...
    

    每行的长度不要太长,建议为80个字符,按照公司规定的流程,如果是修改Bug管理系统中的问题,必须注明Bug单的编号。

      // Add by XXX, YYYY-MM-DD, Bug No.QSXXXXXX
    

    部分RD习惯这样写:

    // Add by XXX
    // End XXX  
    

    在绝大多数情况下,这没有问题,我的方法稍做改变,与之前所说的类似

    #if 1 // Add by XXX, YYYY-MM-DD
    ...Your codes
    #endif
    

    这样写的好处是-在调试时可方便地将改写的代码关闭看原来MTK的效果,而不必去Mark掉。如果只增加了单行代码,并且无须解释就可以明其意,也可以这样写

    ...Your code // Add by XXX, YYYY-MM-DD  
    

    如果习惯使用//Add //End的风格,请注意如下情况

    // Add by XXX
    #if defined(__PROJECT_A__)
    ...
    #elif deined(__PROJECT_B__)
    //End by XXX
    #else
    ...
    ..
    // Add by XXX
    #endif
    // End XXX  
    

    最后这个#endif前后所加注释为多余,有经验的RD看了上半部分便知哪里是改过的,即使有问题,用版本工具一比较即可。

    加了太多的// Add, //End会让代码看起来繁冗不堪,反而影响阅读。

    还有一种情况,在一个函数中修改了很多地方

    void func( void )
    {
    //Add by XXX
    ...
    // End XXX
    ...
    //Add by XXX
    ...
    // End XXX
    ...
    //Add by XXX
    ...
    // End XXX
    }
    

    我建议,当一个函数中修改的部分超过1/3时,不如将此函数分开

    #if 1 // Add by XXX, YYYY-MM-DD
    void func( void )
    {...}
    #else // Orginal code
    void func( void )
    {...}
    #endif
    更多相关内容
  • c语言计算器代码(有注释),可实现二、十、十六等多进制的减乘除运算,可实现界面刷新、返回、退出等多项功能
  • 属于自己的俄罗斯方块,注释很详细了,包含音效文件,新手可以拿去参考制作自己的俄罗斯方块游戏。
  • unity3d植物大战僵尸源代码加注释

    热门讨论 2012-02-12 00:00:45
    unity3d植物大战僵尸源代码加注释植物大战僵尸js源码带注释版本.rar
  • 基于二维数组的dos 版贪吃蛇游戏 字符动画 没有使用图形界面 附代码加注释
  • Dreamweaver怎么给代码添加注释?给代码添加注释是好习惯,方便以后查看程序,该怎么添加注释呢?下面我们就来看看Dreamweaver注释的添加方法,需要的朋友可以参考下
  • ubb代码加注释

    2012-03-22 20:34:46
    this is ubb ubb代码加注释
  • 如何给python代码快速添加注释

    千次阅读 2021-03-06 04:56:03
    python代码快速添加注释的方法选中要注释代码,按下ctrl+/注释。实例#----->1.用一对"""括起来要注释代码:"""number=23guess=int(raw_input('Enteraninteger:'))ifguess==number:print'Congratulations,...

    dd6268bf6e14a0c8c16138b66b21204f.gif

    python代码快速添加注释的方法

    选中要注释的代码,按下ctrl+/注释。

    实例#----->1.用一对"""括起来要注释的代码:

    """

    number = 23

    guess = int(raw_input('Enter an integer : '))

    if guess == number:

    print 'Congratulations, you guessed it.' # New blockstarts here

    print "(but you do not win any prizes!)" # New blockends here

    elif guess 

    """

    #----->2.用一对'''括起来要注释的代码块:

    '''

    print 'No, it is a little higher than that' #Another block

    # You can do whatever you want in a block ...

    else:

    '''

    #----->3.选中要注释的代码,按下ctrl+/注释:

    #   print 'No, it is a little lower than that'

    # # you must have guess > number to reach here

    # print 'Done'

    # # This last statement is always executed, after the ifstatement is executed

    展开全文
  • 关于代码注释的几种方法

    千次阅读 2022-02-08 16:44:56
    vs中常见的注释方法

           注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。注释只是为了提高可读性,不会被计算机编译。

           注释一般分为行注释和块注释,行注释是在某一个注释符号之后的内容不被计算机运行,块注释是在某两个注释符内的内容不被计算机运行。

           我学习使用的是C#,使用的软件是VS2019,常见的行注释我们会用到注释符"//",在某一行需要注释的内容前打上”//“符号,则在符号后的内容将会变为绿色,并且不被运行。如图1所示,加入注释符的一段文字显示绿色,并且不被计算机运行,运行时只会显示一段“Hello World”。

    图1

           块注释时,我们将在需要注释的内容前与内容后分别插入符号"/*","*/",这样整段代码将会变成绿色,并且不被计算机所执行。如图2所示。

    图2

           针对以上的注释方式还有快捷键去使用,如果我们想要把一段代码进行注释时,可以用鼠标选中这一段,按ctrl+K+C,整段变成注释,如需要恢复则把选中段按ctrl+K+U。如图3所示。

    图3

           如果我们在方法和函数前对函数进行说明解释型的注释,在段落上一行按三次"/",则会出现一种专门对下文解释的格式。如图4所示。

    图4 

            通常在面对繁杂的代码时,我们还会经常性选择用一种分块预处理的整理方式 ,可以在使用VS代码编辑器的大纲显示功能时指定可展开或折叠的代码块。首先选中需要折叠的代码块,按ctrl+K+S后并选择"#region,此时这一段代码的左边会有一个"+",点击就可以达到折叠的目的,#region后可以用文字进行解释说明。如图5所示

    图5 

           对于初学者的我,这因该就是比较常见的注释操作方法,以后可能会遇见更多的方式方法。对于刚开始接触代码的我,这是我的第一篇文章,主要为了记录一下自己学习的过程,顺便也能巩固一下自己的知识。

     

     

     

     

    展开全文
  • 注释方法、代码快捷键注释

    千次阅读 2019-10-03 05:45:56
    良好的编码规范是程序员必备的素质,编码中的代码注释尤为重要,健全的代码注释可以提高代码可读性和维护性, 不仅为了标识此块代码的含义,很多时候包含了对业务逻辑的解释,项目中难免有逻辑复杂之处,不注释的...

    1、注释规范

    • 良好的编码规范是程序员必备的素质,编码中的代码注释尤为重要,健全的代码注释可以提高代码可读性和维护性,
    • 不仅为了标识此块代码的含义,很多时候包含了对业务逻辑的解释,项目中难免有逻辑复杂之处,不加注释的代码,
    • 数日后自己看都会觉得陌生,更不要说其他人看了,今天分享一下Objective-C开发中常用的代码注释方式以及应用场合。

    2、注释形式

    • 注释形式主要有:
      • 单行注释,多行注释,方法注释,方法集注释(配合代码块实现快速注释)
    • 2.1 单行注释

      • 使用 // 注释单行代码,最常见的使用场景是在方法内注释某个属性或某块区域的含义,如下图:
        1213778-20180730225958606-1152774359.png
    • 2.2 多行注释

      • 使用 /** 文本 **/ 的注释格式(快捷键cmd+alt+/)可以对属性和类以及方法进行注释,与//不同的是,该注释方式可以写多行,一般使用在类的头文件,多行介绍当前类的含义,如下图:
        1213778-20180730225955777-2117599393.png
    • 2.3 方法注释

      • 与方法2相同,使用 /** 文本 **/ 的注释格式(快捷键cmd+alt+/)可以对方法进行注释,快捷键会根据方法参数自动生成需要填写的注释内容,并且在其他地方使用该方法时,Xcode会智能提示出之前写的注释内容,如下图:
      • 在方法上方使用快捷键 cmd+alt+/:
        1213778-20180730225940159-75878264.png
      • 使用该方法时显示注释内容:
        1213778-20180730225927922-1590590215.png
    • 2.4 方法集注释(配合代码块实现快速注释)

      • 先介绍一下,何为方法集注释,通常没有添加方法集的类是这样的:
        1213778-20180730225907215-1942715514.jpg
      • 为了快速定位类中的某块代码,或某个方法,Xcode为我们提供了方法集的注释方式,可大大减少搜寻目标代码的时间,如图:
        1213778-20180730225853844-1621121236.png
      • 这样就能对类中的方法和模块一览无余,要查找或修改的时候可以迅速定位,节省时间,提高自我体验。
        • 实现方法:
            #pragma mark  <#注释的内容#>
        • 但是每次敲这些字符一定不是你想要的效果,在Xcode8之前可以使用VVDocumenter增强版(个人在原基础上修改添加方法集注释功能),由于Xcode8默认禁用使用插件,所以我们采用代码块+快捷键的方式来实现,效果也是酸爽:
          1213778-20180730225835682-596445817.gif
        • 上图中,就是我使用代码块+快捷键来实现的方法集注释,编写方便,快捷,具体实现步骤如下:
        • 添加代码块并设置快捷键:
          1213778-20180730225822238-991456578.png
        • 这样就大功告成,保存代码块,在代码中使用预设的快捷键,编译器会自动提示,回车,输入即可。
        • 记得代码块预设的时候“注释内容外要用<#>” 。
          1213778-20180730225444735-898140396.gif

    转载于:https://www.cnblogs.com/CH520/p/9393327.html

    展开全文
  • 在MATLAB中,可以注释一段程序 例如 %{ 。。。 % } 在此要注意,“%{”和“%}”都要处于行首!
  • latex添加代码注释Stop me if you’ve heard this one before… 如果您之前听过我的话,请阻止我... “Good code is self-documenting.” “好的代码是自我记录。” In 20+ years of writing code for a living, ...
  • 花了几天时间,参考正点原子的手册,把uboot的启动流程捋了一遍,画了uboot的结构图,顺带给代码加了中文注释
  • Python给代码加注释快捷键

    千次阅读 2019-12-14 14:55:01
    Windows 选中单行或多行+CTRL+/ Mac 选中单行或多行+Command+/
  • 这个代码虽然虽然也是在网上下的,但是为了更好的理解,了自己的注释
  • 在写论文的时候经常要用到伪代码,有时候要对一些算法进行注释更加美观,例如: 对算法注释能够使审稿人更明白你的算法内容,那这样的注释应该怎么? 其实就是一个\Comment{} 命令,在开始之前需要导入算法包...
  • 这样工作量可谓庞大,今天给大家带来关于注释的快捷键使用,一起来看看吧~关于python编程注释快捷键1、注释单行(1)方法1:直接在单行代码前边 #(2)方法2:选中需要注释代码,Ctrl+/ 即可注释2、注释多行代码选中...
  • 在编写程序时,为了使代码易于阅读,通常会在实现功能的同时为代码加一些注释注释是对程序的某个功能或者某行代码的解释说明,它只在C语言源文件中有效,在编译时会被编译器忽略。C语言中的注释有两种类型,具体...
  • 程序示例 原代码加注释ScrollMoreShapes.suo
  • C# 计算器(注释

    千次下载 热门讨论 2013-04-06 16:33:03
    C#版计算器,应C#贴吧人的反应,加上了注释,希望你们能看懂,能帮到大家。
  • 先科普一下eclipse加注释的快捷键: eclipse中编辑Java文件时,注释和取消注释的快捷键都是: "CTRL + / " 编辑xml文件时,注释:CTRL + SHIFT + / 取消注释:CTRL + SHIFT + \ 今天,在用eclipse写Android相对...
  • idea常用插件及代码注释

    千次阅读 2020-07-06 22:31:33
    阿里巴巴代码规范检查插件 https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines Key promoter 快捷键提示插件 https://p...
  • 代码注释删除小工具(java)

    热门讨论 2010-04-24 18:15:07
    用java编写的代码注释删除小工具,能去文本中掉//和/* */注释。 第一个按钮的功能为去掉文本框1中代码的注释,输出到文本框2. 第二个按钮的功能为批量删除文件中的注释,并输出到当前目录(新文件名为xxx.txt)。但...
  • pycharm 之给代码书写代码标准注释

    千次阅读 2019-05-11 14:11:21
    每个人的写代码的时候都是要写开头的,但是每次重复写,有点累,pycharm,有这个解决工具1.下面就是具体的实现步骤 1.每个人的写代码的时候都是要写开头的,但是每次重复写,有点累,pycharm,有这个解决工具 1....
  • AES加注释代码

    2012-10-18 11:27:09
    AES加密技术 非常强大地,有注释
  • java中链表的创建 使用 实例 。初学者用于理解链表的使用。带有60%带有注释。 java链表 链表的讲解 java源代码加注释
  • 在计算机专业书籍或者文章中,经常会用到代码,比如C语言代码,如何在代码中添加注释,用图片的形式展示,这种排版很常见,但是用latex怎么实现? 如图所示的效果,在latex排版中如何实现?完整代码如下 \...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 1,713,171
精华内容 685,268
关键字:

代码怎么加注释