← 返回首页

养成良好的代码注释习惯

2026-04-12 · 工程思考

关于注释,常见的误区是"把代码又用中文翻译一遍"。好的注释不是描述代码做了什么,而是解释为什么这样做——这恰恰是代码本身表达不出来的部分。

解释"为什么"

当一段逻辑背后有约束、历史原因或奇怪的边界处理时,写清楚背景,能让半年后的自己少踩一次坑。这类注释最值钱。

别留下过期注释

代码改了、注释没改,比没有注释更危险——它会主动误导读代码的人。改逻辑时顺手更新注释,是基本修养。

好命名胜过注释

把变量和函数起得清楚,很多时候就不需要额外解释。与其写"计算总价",不如直接叫 calculateTotal,读起来一目了然。

只在必要处注释

普通的顺序流程不必句句注解;把注释留给真正容易误解、或蕴含决策的地方,反而更醒目,也更容易被看到。

← 返回首页