您当前的位置:首页 > 充电吧 > 真心话

程序员添加代码注释的五大技巧,谷歌创始人与众不同的“注释”

时间:2017-10-09 来源:互联网 作者: 标签:程序员   代码注释   

程序员写代码需要代码注释吗?对于这个问题不外乎两种观点。

本文引用地址: http://www.21ic.com/chongdian/zhenxin/2017-10-09/740195.html

一种程序员认为,如果类、方法、变量定义准确,代码注释显得有点多余。最好的代码注释就是没有注释。

另一种程序员认为,必须写代码注释。

谷歌创始人布林

别以为你可以理解自己写的代码,过了两个星期之后,你可能就不知道代码是不是自己写的。

如果是简单的代码,不加注释情有可原,但是,复杂的代码那就必须加注释了。

下面w3cschool分享代码注释的5大技巧:

1、代码注释最基本的原则

 

代码注释一定是注明代码的目的,而不是代码的行为。为何呢?因为通过代码我们就可以清楚行为,多加注释,画蛇添足。

2、使用空格对齐注释行

为了方便阅读起见,代码注释对齐会更好一些。那么问题来了,是用tab对齐还是用空格键对齐呢?

我们都清楚,tab在不同的编辑器和集成开发环境中是不一样的,所以选择空格键对齐会适合一些。

const MAX_ITEMS = 10; // maximum number of packets

const MASK = 0x1F; // mask bit TCP

3、代码少而精

如果说代码注释一定要有,那就就要尽量做到少而精。有些人代码注释写的跟小说一样,这后果是相当严重的...

4、代码“统帅”段落

一些程序员习惯将代码分成多个“段落”,这是非常要好的一个习惯。

以上是谷歌创始人之一布林的代码,他没有在简历中写待遇,直接在html源代码注释:办公室要大,挣钱要多,干活要少...

当然,加个代码注释就会锦上添花。比如在段落代码前加个注释。同样地,就是告诉自己或者维护人员代码的意图。

5、代码注释的精髓

 

不知道有没有小伙伴使用下面这种方式写代码注释,必须要给出大写的“服”!

()

相 关 推 荐

图 酷 信 息

《坐井观车》非典型经典设计宝马M1

《坐井观车》非典型经典设计宝马M1
“坐井观天”比喻眼界狭窄和学识肤浅之人,笔者作为21世纪丝的杰出代表人物,对许多豪车、超跑只可远观不可亵玩焉,《坐井观车》这个图赏栏目将拨开豪车的面纱,让芸芸众生探触到豪车的秘密!本文的初衷是给丝……

更多项 目 外 包