注释是代码的补充

作者: 全新的饭 | 来源:发表于2022-05-16 11:05 被阅读0次

为什么要写注释？

代码无法体现开发者在编写代码时脑中所想的关于当前模块的全部重要信息。
代码太精确了（代码主要是给计算机看的），可通过注释对其表述内容进行总结：让使用者只看较短的注释就能理解很长一段代码是在干嘛。

最好为注释定格式

一般各种编辑器或者语言都有约定俗成的格式，直接照搬就行。
定格式的好处是让读注释的人更易读、写注释的人能专注在自己要表述的内容本身，不用再去想格式的事。

注释不要重复表达使用者能简单快速地直接从代码本身获取的内容。
站在对系统完全陌生的使用者的角度思考，当他要使用系统的某项功能时，他最需要的、最应该注意的哪些信息是缺失的：通过注释进行补全。通过添加注释消除使用者的困惑。

可以这样理解，系统有多层抽象的代码构成，注释相当于向这些层之间又添加了一些新层，使系统展现在使用者心中的形象更清晰明确。

底层：澄清更细节的信息，消除代码的表意模糊。
高层：描述整体结构功能，省略细节，帮助理解代码意图。

本文标题：注释是代码的补充

本文链接：https://www.haomeiwen.com/subject/huniurtx.html