本文探讨了代码注释的重要性，强调了简洁、清晰、便于理解的注释对于代码维护和团队合作的价值。通过引用《可读代码的艺术》一书，作者提出将代码段、文档链接等记录在注释中，如同写日记般保留代码背后的故事。建议开发者多参考高质量开源软件的注释风格，以提升个人代码质量。
代码是给人看的，机器码才是给计算机执行的。所以写代码时，应简练整洁，更要便于人类理解。注释可以帮助人们理解代码的功能，就像几何题目中的辅助线，盖楼房时的脚手架。好的注释可以帮助人们更好的理解代码执行流程，理解总体架构。作者可以把自己的想法，为什么这么写，未来的重构方向，在注释中体现。
注释也可以作为很好的参考文献，可以把代码段，文档网址链接，长函数的形式参数以行间注释的形式记录下来，就和写日记一样。
多阅读高质量的开源软件，看看他们的注释是怎么写的。
References
1. The Art of Readable Code, Dustin Boswell & Trevor Foucher 著
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
