代码是灵魂，注释是心声

痛定思痛。 2022-08-10 11:46 161阅读 0赞

每一个软件开发者都跟代码是好朋友。首先代码应该尽量地简洁，尽可能地做到不需要依赖注释就可以理解。但是有些代码段难于理解，则需要我们添加注释。

![20141127182709361][]

有一本非常经典的书《Structure and Interprettion of Computer Programs》(《电脑程序的结构和编译》)，在序言中表明观点：

![20141127175815200][]

Knuth在其发表的经典论文《Literate Programming》（《文学编程》）中秉持类似的观点：

![20141127180445044][]

如果你写出来的代码，既能被其他程序员理解又能成功编译，那么需要添加注释的地方肯定句不会很多。关于使用注释作为辅助工具，下面看一个例子：

![20141127180518257][]

上面的代码等同于下面的代码，但是下面的代码可读性更高。

![20141127181834701][]

需注意的是，注释的越多并不意味着代码的理解性更强。有时候，注释得越精简代码的可读性也越高。

无论最后你呈现的代码是有多么的简洁和清楚，代码也不可能完全自文档化。但是代码永远也不可能取缔注释的存在。正如Jef Raskin所说：\[代码\]无法解释如此写程序及选择该方法的原因。从\[代码\]上我们也看不出选择某些替代方法的理由。例如：

![20141127182904380][]

在A开发人员看来完全显而易见的东西，可能在B眼里完全就像雾里看花一样。所以我们在写注释的时候，也要考虑到这一点!

**归根究底，代码只会告诉你程序是如何工作的，但是注释则能说明工作的原因。**

[20141127182709361]: /images/20220810/fa15ebe1eba144a0aee1bbfd9f49f0c3.png
[20141127175815200]: /images/20220810/9cf0b98b82e643138b99ff9fca2e3492.png
[20141127180445044]: /images/20220810/dbc6939a570f4cacb2c8d80e90d48d98.png
[20141127180518257]: /images/20220810/23deaac83a674b5197cca2df2fb47da3.png
[20141127181834701]: /images/20220810/b6ca6a7202ff426488badda7cd10a5b9.png
[20141127182904380]: /images/20220810/19500d5925144a0aa2d74762514c0bf9.png

发表评论取消回复

表情：

评论列表（有 0 条评论，161人围观）

还没有评论，来说两句吧...

相关阅读

相关什么是整洁的代码？什么是肮脏的代码？

击上方“芋道源码”，选择“[设为星标][Link 1]” 做积极的人，而不是积极废人！源码精品专栏 * [中文详细注释的开源项目][Link 2] * [...

╰半橙微兮°/ 2024年04月17日 05:41/ 0 赞/ 66 阅读

相关什么是恶意代码?

> 前言：本文旨在分享交流技术，在这里对恶意代码进行全面的介绍和讲解 ![cd1fbc5637b943bbbb0377703e888cf8.gif][] 目录一.什么是

冷不防/ 2024年02月20日 09:36/ 0 赞/ 49 阅读

相关灵魂拷问：为什么 Java 字符串是不可变的？

1. 图文分析来看下面这行代码。 String alita = "阿丽塔"; 这行代码在字符串常量池中创建了一个内容为“阿丽塔”的对象，并将其赋值给了字符串

港控/mmm°/ 2023年06月12日 09:25/ 0 赞/ 57 阅读

相关 pp什么意思_RO膜是什么？为什么说RO膜是净水器的灵魂？

![e1f5ff656b7f4d49ffe915b3e48a4ccf.png][] 随着人们对饮用水质要求的不断提高，各种净水设备层出不穷，走进了千家万户。其中，带RO膜功能

旧城等待，/ 2023年01月03日 05:55/ 0 赞/ 103 阅读

相关开篇词 | 算法是程序的“灵魂”

大家好，我是王晓华，网名 orbit。2015 年出版了一本书，名为《算法的乐趣》，以“趣味性”为着手点，介绍了二十多个趣味算法的原理和实现，主要目的是希望读者了解到算法并非是

川长思鸟来/ 2022年12月09日 11:39/ 0 赞/ 181 阅读

相关笑出腹肌的注释，都是被代码耽误的诗人！

![bc84d11d89d75b1560a398306f58a560.png][] 转自网络，部分出自 Quora 网友 0、这是一个被代码耽误的诗人 ![bdc6acb

￡神魔★判官ぃ/ 2022年08月28日 09:51/ 0 赞/ 141 阅读

相关笑出腹肌！代码注释还是程序员会玩！

点击关注公众号，利用碎片时间学习来源：转自网络，部分出自 Quora 网友 0、这是一个被代码耽误的诗人 ![6a313814f4dbb5402b26e3

「爱情、让人受尽委屈。」/ 2022年08月28日 08:48/ 0 赞/ 162 阅读

相关代码是灵魂，注释是心声

每一个软件开发者都跟代码是好朋友。首先代码应该尽量地简洁，尽可能地做到不需要依赖注释就可以理解。但是有些代码段难于理解，则需要我们添加注释。 ![20141127182

痛定思痛。/ 2022年08月10日 11:46/ 0 赞/ 162 阅读

相关灵魂拷问：创建 Java 字符串，用""还是构造函数

在逛 programcreek 的时候，我发现了一些小而精悍的主题。比如说：创建 Java 字符串，用 "" 还是构造函数？像这类灵魂拷问的主题，非常值得深入地研究一下。

淩亂°似流年/ 2021年09月10日 06:18/ 0 赞/ 347 阅读

相关灵魂拷问：创建 Java 字符串，用""还是构造函数

在逛 programcreek 的时候，我发现了一些小而精悍的主题。比如说：创建 Java 字符串，用 “” 还是构造函数？像这类灵魂拷问的主题，非常值得深入地研究一下。

骑猪看日落/ 2021年05月12日 11:49/ 0 赞/ 388 阅读