程序员优秀代码注释的5个技巧,谷歌创始人的一段代码相当霸气!

新闻 前端
程序员写代码需要代码注释吗?对于这个问题不外乎两种观点。一种程序员认为代码注释显得有点多余,另一种程序员认为,必须写代码注释。

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

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

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

[[209253]]

谷歌创始人布林

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

[[209254]]

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

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

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

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

[[209255]]

2、使用空格对齐注释行

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

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

const MAX_ITEMS = 10; // maximum number of packets

const MASK = 0x1F; // mask bit TCP

3、代码少而精

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

程序员优秀代码注释的5个技巧,谷歌创始人的一段代码相当霸气!

4、代码“统帅”段落

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

程序员优秀代码注释的5个技巧,谷歌创始人的一段代码相当霸气!

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

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

5、代码注释的精髓

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


责任编辑:张燕妮 来源: 头条科技
相关推荐

2015-05-19 14:34:17

程序员编程语言

2015-08-20 09:06:48

程序员

2009-12-28 09:42:14

程序员

2015-06-17 14:24:48

优秀程序员整洁代码

2023-12-24 14:00:33

模型代码

2012-10-09 10:23:07

Linus Torva程序员优秀程序员

2017-10-29 22:36:41

程序员

2014-09-16 10:49:54

MineCraft微软

2011-03-16 14:19:01

程序员Rails

2014-03-25 10:35:35

程序员代码调试

2017-09-05 14:18:29

2014-09-12 10:38:01

程序员代码

2020-12-07 14:46:07

程序员代码分析工具

2021-03-29 23:05:36

程序员工具静态分析

2011-08-31 08:42:24

Java创始人高司令谷歌

2015-09-01 11:20:58

程序员糟糕代码

2015-08-31 10:14:30

程序员处理代码糟糕代码

2015-04-08 11:09:28

优秀程序员深入理解你的代码

2022-06-21 12:27:12

JavaScript前端

2020-12-31 10:14:42

防注入代码绕过
点赞
收藏

51CTO技术栈公众号