1、不准确的注释比没有注释更令人头疼
尽量用语义化的代码来解释你的意图,而不是依赖注释来解释一段代码 原因很简单:程序员不能坚持维护注释。 代码在后期维护中,不断的优化、变动,很有可能最初的注释已和现有的代码没多大关系了,反而给人一种先入为主的思想去了解一段代码。
尽量用语义化的代码来解释你的意图,而不是依赖注释来解释一段代码
原因很简单:程序员不能坚持维护注释。 代码在后期维护中,不断的优化、变动,很有可能最初的注释已和现有的代码没多大关系了,反而给人一种先入为主的思想去了解一段代码。
2、如果一定要写注释,请保证它描述的是离它最近的代码