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

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

admin 12-01 04:30 243次浏览

程序员写代码的时候需要代码注释吗?关于这个问题,最多有两种观点。

一位程序员认为,如果类、方法和变量的定义准确,那么代码注释就有点多余了。最好的代码注释是无注释。

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

谷歌创始人酷皮卡丘

不要认为你能理解你写的代码。两周后,你可能不知道代码是不是你自己写的。

如果是简单代码,可以不用注释,但是复杂代码需要添加注释。

以下是w3cschool分享代码注释的五个技巧:

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

代码注释必须表明代码的目的,而不是代码的行为。为什么呢?因为通过代码,我们可以清楚的知道行为,添加更多的评论,画蛇添足。

2.用空格对齐注释行。

为了方便阅读,代码注释的对齐会更好。那么,问题是,你想与制表符还是空格键对齐?

众所周知,tab在不同的编辑器和集成开发环境中是不同的,所以选择空格键对齐会更合适。

const MAX _ ITEMS=10//最大数据包数

const MASK=0x1F//屏蔽位TCP

3.代码很少,但很好。

如果一定要有代码注释,那就尽量少。有些人的代码评论写得像小说,后果相当严重。

4.代号“总司令”段落

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

以上是谷歌酷创始人之一皮卡丘的代码。他没有把工资写在简历里,而是直接在html源代码里评论:办公室要大一点,挣钱多一点,工作少一点。

当然,添加代码注释会锦上添花。例如,在段落代码前添加注释。同样,这意味着告诉自己或维护者代码的意图。

5.代码注释的本质

不知道有没有朋友用下面这种方式写代码注释。他们必须给大写的“服务”!

【C#基础】Substring截取字符串的方法小结(推荐)计算一个字符串中有多少回文DeepRust匹配:有更好的方法吗?C++构造析构赋值运算函数怎么应用
lombok是哪里(java的getter) word文档加注释(法条要买注释版吗)
相关内容