【转】编写高质量代码改善C#程序的157个建议——建议152：最少，甚至是不要注释...

 

建议152：最少，甚至是不要注释

以往，我们在代码中不写上几行注释，就会被认为是钟不负责任的态度。现在，这种观点正在改变。试想，如果我们所有的命名全部采用有意义的单词或词组，注释还有多少存在的价值。

即便再详细的注释也不能优化糟糕的代码。并且注释往往不会随着代码的重构自动更新，有时候我们可能会在修改代码后忘记更新那段用来表达最初意图的文字了。所以，尽量抛弃注释吧，除非我们觉得只有良好的代码逻辑和命名仍旧不足以表达意图。

当然，有些注释可能不得不加，如一些版权信息。另外，如果我们正在开发公共API，保持一份良好的严格按照格式要求所写的注释有利于生成API参考手册。

当前有一种主张：不要写注释，或者尽量保持最少注释。

但前提是所有的命名全部采用有意义的单词或词组。

 

 

转自：《编写高质量代码改善C#程序的157个建议》陆敏技

转载于:https://www.cnblogs.com/farmer-y/p/8022212.html