8. 注释

注释虽然写起来很痛苦, 但对保证代码可读性至关重要. 下面的规则描述了如何注释以及在哪儿注释. 当然也要记住: 注释固然很重要, 但最好的代码应当本身就是文档. 有意义的类型名和变量名, 要远胜过要用注释解释的含糊不清的名字.

你写的注释是给代码读者看的, 也就是下一个需要理解你的代码的人. 所以慷慨些吧, 下一个读者可能就是你!

• 8.1. 注释风格
• 8.2. 文件注释
• 8.3. 类注释
• 8.4. 函数注释
• 8.5. 变量注释
• 8.6. 实现注释
• 8.7. 标点, 拼写和语法
• 8.8. TODO 注释
• 8.9. 弃用注释
• 译者 (YuleFox) 笔记