知识卡片

注释说明意图

专业/工作

内容

注释不应重复代码做了什么,而应说明意图、约束、边界和不显然的原因。能用代码清楚表达的地方就改代码。发散:好注释像路标,指出背景和危险;坏注释像字幕,复述眼前画面。

参考来源

《高效程序员的45个习惯:敏捷开发修炼之道 (图灵程序设计丛书 11)》第6章《敏捷编码》