Tech Neo技巧沙龙 | 11月25号，九州云/ZStack与您一路商量云时代收集界线治理实践

法度榜样员写代码须要代码注释吗?对于这个问题不过乎两种不雅点。

一种法度榜样员认为，如不雅类、办法、变量定义精确，代码注释显得有点多余。最好的代码注释就是没有注释。

另一种法度榜样员认为，必须写代码注释。

谷歌开创人布林

别认为你可以懂得本身写的代码，过了两个礼拜之后，你可能就不知道代码是不是本身写的。

如不雅是简单的代码，不加注释情有可原，然则，复杂的代码那就必须加注释了。

下面分享代码注释的5大年夜技能：

代码注释必定是注明代码的目标，而不是代码的行动。魏何呢?因为经由过程代码我们就可以清跋扈行动，多加注释，画蛇添足。

2、应用空格对齐注释行

为了便利浏览起见，代码注释对齐会更好一些。那么问题来了，是用tab对齐照样用空格键对齐呢?

const MAX_ITEMS = 10; // maximum number of packets

const MASK = 0x1F; // mask bit TCP

3、代码少而精

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

我们都清跋扈，tab在不合的编辑器和集成开辟情况中是不一样的，所以选择空格键对齐会合适一些。

4、代码“统帅”段落

一些法度榜样员习惯将代码分成多个“段落”，这是异常要好的一个习惯。

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

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

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

5、代码注释的精华

不知道有没有小伙伴应用下面这种方犯写?码注释，必须要给出大年夜写的“服”!