本文探讨了代码注释的重要性与原则，强调了高质量注释对于维护与理解代码的价值。它指出，注释应补充代码无法表达的关键信息，如功能概述与意图，并建议避免冗余注释，采用易于维护的表达方式。通过改进代码结构减少注释需求，实现更清晰、高效的编程实践。
要点
- 该不该注释是个需要认真对待的问题。差劲的注释只会浪费时间，帮倒忙；好的注释才有价值。
- 源代码应当含有程序大部分的关键信息。只要程序依然在用，源代码比其他资料都能保持更新，故而将重要信息融入代码是很有用处的。
- 好代码本身就是最好的说明。如果代码太糟，需要大量注释，应先试着改进代码，直至无须过多注释为止。
- 注释应说出代码无法说出的东西——例如概述或用意等信息。
- 有的注释风格需要许多重复性劳动，以舍弃之，改用易于维护的注释风格。
扫一扫
评论
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
查看更多评论
添加红包
