Redis是如何写代码注释的.docx

Redis是如何写代码注释的 许多人认为，如果代码写得足够扎实，注释就没什么用了。在他们看来，当一切都设计妥当时，代码本身会记录其作用，因此代码注释是多余的。我对此持不同意见，主要出于两个原因： 1、许多注释并未起到解释代码的作用。 2、注释使读者不必凭空想象太多细枝末节，帮助读者降低认知负担。 注释的分类 我的工作始于随机地阅读Redis源代码，以检查注释是否以及为什么在不同的上下文中起作用。我很快发现，注释的作用来源于多方面：它们在功能，编程风格，长度和更新频率方面往往非常不同。我最终转向了注释分类。 在研究期间，我确定了九种注释类别： * 函数注释 Function comments * 设计注释 Design comments * 原因注释 Why comments * 教学注释 Teacher comments * 清单注释 Checklist comments * 引导注释 Guide comments * 琐碎注释 Trivial comments * (代码)负债注释 Debt comments * 备份注释 Backup comments 在我看来，前六个主要是非常积极的注释形式，而最后三个有点值得怀疑。在接下来的部分中，我将使用Redis源代码中的示例分析每种注释类型。 函数注释 函数注释的目标是防止读者直接阅读代码。 在阅读注释之后，读者应该可以将一些代码视为