精华内容
下载资源
问答
  • 编写代码不不写注释

    千次阅读 2012-11-21 20:27:47
    代码不写注释就是这样的一件小事,但是这个现象显示的深层道理一点也不小。 写了这么多年了代码了,见过很多人还是规规矩矩的将代码写好,而且并写一个高质量的注释来让代码更加饱满;也见过很多人写起来代码...

            有时候,一件小的事情,未必小。写代码不写注释就是这样的一件小事,但是这个现象显示的深层道理一点也不小。

     

            写了这么多年了代码了,见过很多人还是规规矩矩的将代码写好,而且并写一个高质量的注释来让代码更加饱满;也见过很多人写起来代码行云流水,潇潇洒洒,但是一句注释也没有;所以我就经常看到这样的现象和听到这样的话语:

     

             Xxx,搞毛线啊,连个注释都不写,他摇摇屁股走人了,把我给坑死了。。。。

             Xxx,你自己写的代码,你都不知道是什么意思了啊,你搞笑呢吗。。。。。

             Xxx,你解决个bug这么慢啊,怎么回事,把你代码发过来我看看,。。。。。。过了好长时间。。。。哥,我真看不了你的代码,你的代码写的太好了,连个注释都没有,怎么解决bug,费死牛劲了。。。。

             Xxx,你学代码学习人家yyy,你看看人家代码写的,别人看是享受;你的代码,别人看是想哭。。。。

     

            各种现象,都会出现,这些例子都从方面说明了写注释的重要性,而且好的代码就应该有注释辅佐,才能更加有艺术效果。

     

            其实,从历史的角度来看,注释这个神奇的东西就已经存在了。我们读的古书、古诗还有古文都会有注释的。这些注释目的很简单有助于读者对这段文字的理解。

     

            在n多个古人和经验教训的归纳总结,形成了软件工程这门科学知识。软件工程这门课程给我提供了编程道路的一盏明灯,它告诉我们编程是一件什么样的工作,做什么,怎么做。所以软件工程的每一本教材都告诉我们写代码要加注释,而且要学会加高质量的注释。

     

            不管从历史,还是从软工来看,代码也就应该有注释来搭衬,才能彰显代码的艺术效果。这样才能让读者明白代码作者的编程意图,也为日后读这段代码做了很好的铺垫,当这段代码出现问题的时候,我们能够很快的将问题找到并解决。

     

            但是很多人还是将自己处在一个创造者的姿态,不服从历史的教训,不听从软工的教导,写代码就不加注释,所以这些人一定会遇到我文章一开的几种现象,到时候他们就知道不写注释是有多么不好了。亲身体会才能体会到痛和自己埋下的祸根自己受就是这样的道理。

     

            所以要想写出高质量的代码,写注释不一定行,但是不写注释一定不行。写注释是前提,随着写的量多了一定会达到质变(不光是注释还有代码)。

     

            所以编程不是一件仅写代码的事情,除了代码,还有很多,其中就有注释。。。。。

     

            推荐:

               代码质量随想录---作者:爱飞翔

     

         代码质量随想录(一):可读是王道

         代码质量随想录(二):必也正名乎

         代码质量随想录(三):名字好,误会少

     代码质量随想录(四):排版,不只是为了漂亮

     代码质量随想录(五):注得多不如注得巧

     

    展开全文
  • 一、写代码写注释 “写代码写注释”自从学编程,这就话就伴随着你。可见注释的重要性。 注释的作用: 说明函数的功能 说明函数参数的意思 说明函数这样设计的原理(计算公式) 说明函数的使用场景 作者和日期 ...

    一、写代码要写注释

    “写代码要写注释”自从学编程,这就话就伴随着你。可见注释的重要性。
    注释的作用:

    • 说明函数的功能
    • 说明函数参数的意思
    • 说明函数这样设计的原理(计算公式)
    • 说明函数的使用场景
    • 作者和日期
    • 说明变量的作用
    • 函数调用方法与注意事项

    总之为了能让读这个函数的人明白这个函数的功能,可以注释各种各样的信息。而没有这些注释文字,就不太容易看懂函数的功能与调用用方法。没有注释的情况下,隔一段时间之后,自己也看懂的自己所写函数的功能了。因此,很多书籍、老师、领导、同事、包括你自己,都会告诉你“一定要写注释,不写是万万不能的”。

    二、注释标准格式

    其实注释没有特别严格的注释格式,但是为了使得注释整齐简洁。还是会有一些格式的要求的。针对不同开发平台,不同编程语言,都有各自不同的注释推荐格式。(高级一些IDE会提供注释快捷键)下面分别列举一些常见的注释格式:

    1. C#
    /// <summary>
    /// 这个方法的作用就是求两个整数之间的最大值
    /// </summary>
    /// <param name="n1">第一个整数</param>
    /// <param name="n2">第二个整数</param>
    /// <returns>返回比较大的那个数字</returns>
    public static int GetMax(int n1, int n2) {}
    
    1. Qt_C++
    /*
     * @Brief:  
     * @Param:  First
     * @Param:  Second
     * @Return: NULL
     */
     void DataManager::SaveValue(int First, int Second) {}
    
    1. Java
    /**
    * This method inputs a number from the user.
    * @return The value output as a double.
    * @exception IOException On input error.
    */
    public double getNumber() throws IOException {}
    
    1. 单片机中的C语言(格式1)
    /*
    ******************************************************************************************
    *	函 数 名: TMC26X_ReadWriteByte
    *	功能说明: TMC26X读写一个字节函数
    *	形    参: val写入值
    *	返 回 值: 读回状态值
    ******************************************************************************************
    */
    UINT8 TMC26X_ReadWriteByte(UINT8 val)
    
    
    
    1. 单片机中的C语言(格式2)
    /**
     * @brief	开始输出指定频率的PWM波
     * @param	frequency PWM频率 单位:Hz
     * @retval	无
     */
    void BSP_PwmStart(uint32_t frequency) {}
    

    三、注释类型有哪些?

    其实一般没有这个概念,只是本文为了更好的解释说明注释的作用,给分别进行了定义。分别如下:

    • 翻译类型注释
    • 函数编写背景说明注释
    • 实现原理注释
    • 编程技术注释

    下面编写一个真实的函数来举例说明各种类型的注释:

    //此函数用于建立“温度”与“温度传感器电阻”之间的线性关系   //编写背景说明注释
    //函数:计算直线公式                             //翻译类型注释
    //功能:通过2个点来计算出直线方程的k和b              //原理类型注释
    //参数:w1 第一个温度值, 
    //参数:z1 第一温度值对应的温度传感器电阻值           //翻译类型注释,把字母翻译成有实际意义的名字
    //参数:w2 第二个温度值, 
    //参数:z2 第二温度值对应的温度传感器电阻值           
    //参数:k 计算出来的斜率                         //翻译类型注释,把一个字母翻译成实际对应的意义
    //参数:b 计算出来的截距          
    //返回值:无                                  //编程技术注释
    void JiSuanZhiXianGongShi( float w1, float z1, 
                            float w2, float z2,
                            float* k, float* b) {
        float temp_k; //临时变量
        float temp_b;
    
        //使用到饿直线公式为:y = k*x + b             //原理类型注释
        //以下代码通过“代入法”分别计算出k和b
        temp_k = (z2 - z1) /(w2 - w1);
        temp_b =  z2 - temp_k * w2;
    
        //通过指针类型形参返回计算结果                //编程技术注释
        *k = temp_k;
        *b = temp_b;
    }
    
    
    
    

    从以上代码注释实例中可以看到,“原理注释”和“背景说明注释”相对来说很重要,如果不写的话,阅读代码的人就看不懂代码。而其余的主要是“翻译类注释”,即把一个字符符号翻译转化为有实际意义的名字(解释其代表的意义)。

    四、“其实不用写注释”(^_^哈哈哈)

    以上说明文字和例子,充分举例说明了“代码注释”的重要性。但是也许你也发现这样一个现象。在实际编码工作中,大部分人是不写注释的。他们为什么不写。是偷懒吗?

    1. 嗯,是有偷懒的嫌疑,那么能给出偷懒的理由吗?理由如下:
    • 我写的是应用软件代码,有几万行代码等着我写,如果不是重要的注释,我是不写的。因为给每个函数都配一个汉语注释是不现实的。
    • 软件开发中,大部分注释是“翻译类型注释”,我只要把函数名字和变量名字起合适了,是不需要再去写啰嗦的注释(我要避免过度注释)
    • 切换中文输入法很麻烦,我英语比较好,同事也能看懂。因此我直接用“英语”写函数名字和变量名字即可。不需要写中文注释。
    • 写注释之后还要维护注释,否则注释反而造成了错误的引导,所以我干脆不写。
    • Linus Torvalds(Linux内核之父)给出的回复是:“Read the fu*king source code”。
    1. 嗯,以上的理由也挺充分。那么不写注释的代码是什么样子的,别人能看懂吗,请看如下代码。
    • 使用英语函数名字和变量名字代替“注释”(注意:仅保留原理类型注释)
    void Get_K_B_OfLinearFunction( float temperature1, float resistance1, 
                                float temperature2, float resistance2,
                                float* k, float* b) {
        float temp_k;
        float temp_b;
    
        //y = k*x + b 
        temp_k = (resistance2 - resistance1) /(temperature2 - temperature1);
        temp_b =  resistance2 - temp_k * temperature2;
    
        *k = temp_k;
        *b = temp_b;
    }
    
    
    • 使用合适的“拼音”变量名字代替“注释”(注意:仅保留原理类型注释)
    void HuoQuZhiXianFangChengDe_K_B( float wendu1, float dianzu1, 
                                float Wendu2, float dianzu2,
                                float* k, float* b) {
        float temp_k;
        float temp_b;
    
        //y = k*x + b 
        temp_k = (dianzu2 - dianzu1) /(wendu2 - wendu1);
        temp_b =  dianzu2 - temp_k * wendu1;
    
        *k = temp_k;
        *b = temp_b;
    }
    
    1. 要不要写注释的结论
      很显然,这两个函数例子中几乎没有写注释,仅注释了一个“直线方程的公式”。也就是说我们几乎没有“注释可看”,而我们可以看到的是“函数名字”和“参数变量名字”,然后再阅读函数中的代码实现。阅读代码的人可以准确的知道这个函数的真正功能。在理解的同时,还会对代码有一种“切实”的理解。因此调用这个函数的时候可以做到“心知肚明”。

      而如果只看注释不看代码,在调用函数的时候,就会有个“镜中花,水中月”的一种虚幻的感觉。因此还是的阅读一下函数实现代码。

      因此,最终的结论是:
      在良好“函数名字”和“变量名字”的辅助下(前提下),是不需要写“注释的”。如果要写,只要写“实现原理类型”和“设计背景说明类型”的注释即可。(另外可以专门去阅读一下大型开源软件的源码,看看大牛们是否写注释)。

    五、必须需要写完整注释的特例

    1. 接口函数
      另外要说明一点,在写接口函数的情况下,注释是要求“完完整整”写全的。比如常见的大公司提供的SDK。其中sdk内部实现功能的代码是不必写注释的。但是对外提供的“接口”函数,是必须要完整写注释的(包括函数功能,参数说明,使用方法说明,返回参数说明)。
    2. 硬件驱动函数(单片机程序代码函数)
      由于单片机的代码函数都和硬件紧密相关。函数中经常操作的的是“寄存器”,寄存器一般都是字母缩写。如果不写注释的话,那是真的无法看懂。其次,单片机的代码量相对应用软件来说代码很少,因此给每个函数都配一个中文注释是可接受的。因此要求“单片机”的程序代码都要写注释。
    展开全文
  • 代码不不写注释

    2016-06-14 12:06:24
    http://blog.csdn.net/lfsf802/article/details/8209597
    展开全文
  • 有什么比花时间写注释更令人感到兴奋的事情吗?如果我没有猜错,你可能会说:“不好意思,所有事情都比写注释更令人感到兴奋”。如果有人要你给代码加上注释,对你来说就像是一种侮辱。你的代码写得如此优雅,它已经...

    有什么比花时间写注释更令人感到兴奋的事情吗?如果我没有猜错,你可能会说:“不好意思,所有事情都比写注释更令人感到兴奋”。如果有人要你给代码加上注释,对你来说就像是一种侮辱。你的代码写得如此优雅,它已经足以说明它要做的事情,注释是多余的,代码就是一切。

    无论是开源项目还是专业软件开发,代码注释通常有两种形式:要么没有和要么毫无用处。任何领域或使用任何编程语言的程序员,无论他们来自世界的哪个地方,似乎都不喜欢给代码写注释。如果你想讲故事,可能会选择不同的人生道路(比如去当作家?)。

    这种不情愿甚至形成了某种范式和哲学观点,认为代码注释实际上是有害的,任何试图逃避它的人现在都可以愉快地重新讨论这些主张。但是,稍微夸张一点说,我们实际上是在用这种方式破坏信息。虽然代码注释有时候确实会适得其反,但真正有害的是我们对它的看法。

    说到底,代码注释就像是错误处理,我们很早就被告知它很重要,但却无法理解其中的原因。我们越来越厌烦为同样的老师、主管或烦人的队友做这件事。但就像错误处理一样,如果做得好,我们就是从中获益最多的人。但要做到这一点,我们需要面对一些严酷的事实,并承认根本不存在所谓的自解释代码。

    所以,让我们来戳破其中的一些泡沫吧!

    自解释的代码是不存在的

    反对给代码写注释的人认为,“代码应该好到不需要任何多余的解释”。好的代码确实不需要注释来描述变量或函数是干什么用的。

    // bad start:int a = 4 * OFFSET;// but don't use a comment to tell what it does:int a = 4 * OFFSET; // initial foo value// instead choose a name telling it itself:int initial_foo = 4 * OFFSET;

    确实,有意义的变量名根本不需要注释,但这实际上更像是一种体面的编码风格,而不是文档。当这种片面的观点变成反对使用代码注释的普遍理由时,问题就出现了。

    问题是,即使变量、方法、类、函数、模块的名称是自解释的,但这些并不能描述出代码的全局面貌,也不一定能说明各部分代码为什么要那么写。当然,清晰的实现往往会让我们产生一种错觉,认为不需要再写注释了。当你花了几个小时甚至几天时间解决了手头的问题,那些代码在当下可能是完美的,然后你把它们打包、提交。

    但是一个月后会怎样?你能记住多少细节?它们还是那么有意义吗?

    软件开发困难重重

    当然,有人可能会争辩说:“代码就在那里,你看一下就明白了”。如果我们说的是某块代码是干什么用的,那么或许这么说是有道理的。但对于任何超出这个范围的东西,深挖代码可能是在浪费时间,就像在阅读一本没有索引的书,你要从头读起,才可能找到你需要的东西。

    而且,这不仅仅是为了了解别人的代码,或者向别人解释你的想法。当你重新查看旧代码或者修复错误时,你的脑子里是不是经常犯嘀咕,或者因为 git blame 显示了你的名字而感到惊讶?然而,再往后,它们可能被忘得一干二净,然后你会再次相信一切都应该是自解释的,所有的细节都应该是明确无误的。

    无论你怎么努力,软件本身并不会完全自解释。这既不是你的错,我也不是想要质疑你的能力,这与人类本身有关,我们低估了软件的复杂性,而且人类的思维具有波动性。注释的目的不是为了指出代码中存在的缺陷,而是为了抵制编程语言本身存在的缺点。即使是最干净的代码也不可能自己解释写代码的人在写代码时在想些什么。有可能一切都是完美的,但仍然会出错。注释并不是干净代码的替代方法,而是代码的固有组成部分。

    代码注释解析

    在进一步讨论我们的问题之前,先让我们来看看不同的代码注释风格。

    /*** Javadoc-style documentation comment.*/void foo(void) {if (bar \u0026gt; 10) {/* regular comment */...}}

    常规注释就是编程语言本身定义的注释。根据经验,它们不应该被广泛使用,因为它们倾向于用来解释代码在做什么。

    另一方面,文档注释从外部角度描述了全局变量、函数和模块。在函数体内部,它们基本上就是常规注释,工具通常会忽略它们。如果在函数内部有一些值得描述的东西,看看是否可以把它们放进函数描述本身。

    文档注释本质上就是常规注释加上一些额外的附件,例如额外的正斜杠/// doc comment、感叹号//! doc comment或者/*! multiline doc comment /,或者Javadoc注释中的附加星号/* doc comment */。实际上,其他编程语言和工具也支持Javadoc,所以这里就以它为例子。

    当然,你也可以使用常规注释,并忘掉那些时髦的标签。不过,一些文档生成器(如 Doxygen 或 Sphinx)可以直接根据注释创建 PDF、HTML 或手册页,大多数现代 IDE 为它们提供了额外的显示支持,省得你老是进行上下文切换,而且还可以为你提供一些有用的信息。

    除了注释的后处理之外,注释的格式并不重要,重要的是你想要表达什么。

    冗余的注释聚焦在错误的信息上

    我们已经得出结论,即不应该记录代码在做什么,而是记录为什么要这么做以及怎样做,但这究竟意味着什么呢?

    人们不喜欢写注释的一个常见原因是“它们只是在陈述已经很明显的东西”,所以注释是多余的。对于一般性的注释,确实难以反驳,特别是在面向对象语言的封装方面。一些简单的函数,比如 get_temperature() 的一般性描述可能如下所示:

    /*** Returns the temperature.*/int get_temperature(void) {return temperature;}

    这里的注释确实没有增加太多的价值,它本质上只是重复了函数的名字,只是在说明这个函数的作用。这不是我们想要的,我们想要的是代码没有告诉我们的东西。

    这个函数非常简单,所以写注释是绝对没有必要的。但话又说回来,软件开发当中没有什么东西是真正简单的。如果你够仔细,就会发现每个函数都有值得写的东西,而这些东西并不能从它的名字甚至是简单的一两行代码中看出来。

    /*** Returns the temperature in tenth degrees Celsius* in range [0..1000], or -1 in case of an error.** The temperature itself is set in the periodically* executed read_temperature() function.** Make sure to call init_adc() before calling this* function here, or you will get undefined data.*/int get_temperature(void) {return temperature;}

    事实证明,这个看似简单的函数有很多额外的信息可以写。如果只是看代码,可能无法明显地看出其中的信息,包括内部数据处理和程序流程。当然,深挖代码最终会获得同样的信息,但这样会浪费很多时间和脑力。

    有人可能会说,我们没办法为这些实现细节写注释。为什么要这样?为什么不详细说明那些现细节,让别人可以更容易地理解代码在做什么?

    每个函数都有自己的特点,至少会有一个细节、副作用、异常、限制,等等,它们都值得写出来,这意味着你可能需要从不同的角度来看待这个函数,才能找出它们。为此,你不可避免地要沉浸在代码隐藏的细节当中,这样才可能发现一些之前没有想到过的特殊情况。因此,代码注释不仅可以帮助读代码的人理解代码,还能帮助写代码的人更好地了解代码的内部细节。

    如果你确实找不到有用的信息,那么应该问问自己为什么要写这些代码。这些代码存在的理由是什么?而这些理由就是有用的信息。之前的例子也可以是这样:

    /*** Returns the temperature.** This is for testing purpose only and should* never be called from a real program.*/int get_temperature(void) {return temperature;}

    请注意,这段代码与之前完全相同,于是这又把我们引向了另一个问题“看似自解释的代码的注释通常都很简单”:它可能含糊不清,可能会导致错误的假设和潜在的缺陷。指出这些细节并消除潜在的歧义对于提升代码质量来说至关重要,这说明注释应该成为代码的重要组成部分。

    同样,如果不深入研究代码,就无法发现每个函数的特点。当然,在这些不起眼的细节中,总有一些比另外一些更值得我们注意,并不是说函数所涉及的东西都会很有趣。认知偏差的范围很广,有些东西在这个时刻对你来说是显而易见的,并不意味着对于其他人来说也是这样——包括未来的你。

    让注释成为代码的一部分

    现在我们来看看另一个人们不喜欢写代码注释的原因:当代码发生改变时,注释会过时。但其实这只是一个偷懒的借口,在写代码时通常不会考虑将来会不会再去修改代码,一旦代码被提交并合并,就是确定和完美的,并永远保持原样。

    代码注释的另一个更大的问题是,它们被视为独立于代码的东西,完全与代码相分离。但如果我们将其视为代码的组成部分,或者一种补充实体,那么只要代码发生变化就会很自然地去调整注释。

    打破恶性循环

    没有人喜欢糟糕的代码注释,但排斥写注释对解决这个问题并没有任何帮助。修复开发人员和代码注释之间的不正常关系是改善这种状况的唯一方法,而将注释视为代码的组成部分是改善这种关系的第一步。

    毫无疑问,在形成这种思维方式之前需要进行练习。从长远来看,这对提升代码质量来说是有益而无害的。

    英文原文:

    https://hackaday.com/2019/03/05/good-code-documents-itself-and-other-hilarious-jokes-you-shouldnt-tell-yourself/

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

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

    千次阅读 2014-11-24 12:39:47
    “程序员最讨厌的四件事:写注释、写文档、别人不写注释、别人不写文档” 豆瓣上有被折腾的大神吐槽: “憎恨不写注释的人!!下班前准备好麻袋,还要一个榔头,血洗……” 也有同学们反驳: “好的代码本身就是...
  • 最讨厌在写代码的时候写注释, 最讨厌别人的代码里面不写注释 那为啥要写注释呢?   我就以自己的亲身经历和理解开始阐述吧:   这段时间在微店实习, 最开始干的事情就是将原来北京团队的代码迁移到杭州, ...
  • 避免在代码写注释

    千次阅读 多人点赞 2013-03-14 14:21:45
    如果用很多注释来“装饰”代码是件好事的话,那么在代码中加入大片大片的注释便是锦上添花了。是这样吗?事实上完全是这样的。过犹不及,好心也会办坏事。 '************************************************* ' ...
  • 有什么比花时间写注释更令人感到兴奋的事情吗?如果我没有猜错,你可能会说:“不好意思,所有事情都比写注释更令人感到兴奋”。如果有人要你给代码加上注释,对你来说就像是一种侮辱。你的代码写得如此优雅,它已经...
  • 有一次,我看懂了一点,就自己标记了点注释给自己看,谁知道让人家看到了,人家说不要写注释,人家说注释其实没有什么用的,后面还加上“真的骗你”。 我不知直接领导是出于什么目的,也许是他愿让别人搞懂他...
  • 简单是可靠的前提条件真正程序员从来不写代码注释,如果代码非常难写,那么同样代码注释也会非常难懂看看当前计算机程序糟糕的事态,软件开发明显一直是一门妖术,其仍然不能被...
  • 代码注释怎么

    千次阅读 2017-05-15 00:20:33
    注释怎么写注释的作用是什么?我认为注释最终作用无非就两个。 1.和伪代码一样的作用,为接下来要实现的功能写出一个指导性的算法思路。只是没有伪代码详细。但是也指出了完成此功能的大体算法思路。 2.给看代码...
  • 注释虽然起来很痛苦, 但对保证代码可读性至关重要,下面我们就以C/C++代码规范注释为例,将描述如何注释以及有哪些讲究。 1 注释风格 1. 总述 一般使用 // 或 /* */,只要统一就好。 2. 说明 // 或 /* */ 都可以,...
  • 如果我没有猜错,你可能会说:“不好意思,所有事情都比写注释更令人感到兴奋”。如果有人要你给代码加上注释,对你来说就像是一种侮辱。你的代码写得如此优雅,它已经足以说明它要做的事情,注释是多余的,代码就是...
  • 教你代码注释

    千次阅读 2019-12-08 21:35:31
    前言 相信大家都会遇到这种情况:一周前自己写的代码,现在再拿出来看,发现读懂了,“ 这代码是我写的???”。...既然注释这么多好处,为什么我们程序员还是愿意写注释? “代码都写完...
  • 代码注释应该怎么

    千次阅读 2016-02-28 20:28:19
    前两天有同事向我抱怨不会写代码注释,知道写些什么,明明很简单的功能啊,一看就懂了,还怎么写注释?
  • 写程序愿意写注释的问题

    千次阅读 2018-02-03 17:53:26
    结构清晰简单、很容易维护的代码可以少写甚至不写注释,写多了注释反而会降低工作效率。 代码越复杂越不容易维护,维护的人越是参差不齐,越是需要认真写注释。 判断注释、文档写的够不够其实很容易验证。如果代码...
  • 整洁代码--注释

    2016-08-16 14:59:22
    写在标题前:看了很多资料说“写注释是为了弥补代码表达意图时的失败”,的确有道理,好的代码确实是太需要注释的,但这种情况目前我只感觉是存在于理想中,现实中,尤其是国内,注释还是很重要的,注释写的清楚,...
  • 程序员为什么不写注释

    千次阅读 2016-03-24 00:06:20
    记得刚参加工作,经理就给组里的人发了一份他...的确如此,我们希望看到别人的注释,同时又想给自己的代码写注释。对于那些开源大型项目,一般会有良好的注释,团队本身也非常优秀,管理规范,项目拥有大量的用户,这
  • 大家应该都知道 在dw 中的各种注释应用吧 其实注释 在各种语言中都是必可少的协调和说明工具!!!   甚至在html中 在 PHP 中 居然可以用循环的 。。。。。   //、 /* */ 、‘’、 “” 等等 都是各有用途...
  • 但是,请注意,我说的是“在大多数情况下”,因为有一些情况下,你应该写注释。 还相信?那让我告诉你:写注释有时会坏事!会导致坏代码! 请允许我用一句名言来开始我的论证:不要注释坏代码——重写吧。——...
  • 问题:在使用shift+ctrl+F格式化代码的时候会出现以下的情况,注释也会格式化,把在一行的注释分为两行显示,可读性高而且格式友好。 友好的格式:   实际需要的格式:   问题解决: 首先进入window-->...
  • 代码注释

    2018-09-11 08:50:19
    所以我们不是为写注释写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下。 原则: 1、注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中...
  • 代码规范-注释

    千次阅读 2016-08-07 18:19:27
    代码规范-注释引言-《代码大全》对于投机取巧的代码注释是错误的,注释不应该帮扶难度大的代码,就像kernighan和...在习惯性的不写注释时,他们会更用心地写好变量名,函数名,代码质量会进一步提高。很多人支持代码
  • 写代码注释的重要性

    千次阅读 2015-09-20 17:58:30
    大神说,他写的代码优秀到不用写注释。。。。我也知道他有多优秀,我想看看其他比较知名的框架代码是怎么写的,于是,我试着第一次npm install jquery,震惊了。。。。基本每行都有注释。。  不管大家说jquery...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 31,962
精华内容 12,784
关键字:

代码不写注释