建议152:最少,甚至是不要注释
以往,我们在代码中不写上几行注释,,就会被认为是钟不卖力任的态度。此刻,这种不雅概念正在转变。试想,如果我们所有的定名全部给与有意义的单词或词组,注释还有几多存在的价值。
即便再详细的注释也不能优化糟糕的代码。并且注释往往不会跟着代码的重构自动更新,有时候我们可能会在改削代码后忘记更新那段用来表达最初意图的文字了。所以,尽量丢弃注释吧,除非我们感受只有良好的代码逻辑和定名仿照照旧不敷以表达意图。
固然,有些注释可能不得不加,如一些版权信息。此外,如果我们正在开发大众API,连结一份良好的严格凭据格局要求所写的注释有利于生成API参考手册。
当前有一种主张:不要写注释,或者尽量连结最少注释。
但前提是所有的定名全部给与有意义的单词或词组。