给未来的便条
代码里写注释,是给以后看代码的人(包括自己)留便条。

你写日记会加括号解释吗?比如“今天吃了冰棍(妈妈不知道)”。程序员写代码也常加“括号解释”,叫“注释”。注释是写给“看代码的人”看的,电脑会忽略它。谁会看代码呢?可能是合作的小伙伴,也可能是几个月后的你自己——所以注释就是给未来的便条!
你知道吗
你知道吗?很多大公司的代码,注释比代码本身还多。因为代码只说“怎么做”,注释才说“为什么这么做”。后人改代码,先看注释才不会改错。
注释写什么
好的注释不重复代码,而是解释“为什么”。比如代码是“if 成绩<60”,注释不该写“如果成绩小于60”(这是废话),该写“// 60 分及格线,低于要补考”。再比如一段奇怪的算法,注释要说“// 用快排因为数据量大,比冒泡快”。注释还要写每个函数干什么、参数是什么、返回什么,方便别人用。
注释也有讲究。太多注释跟代码对不上,反而误导(改了代码忘改注释)。太啰嗦的注释像念经,没人看。最好的注释是“关键处点睛”:复杂逻辑解释一下、特殊情况说明一下、临时方案标个 TODO(待办)。好代码本身应该尽量清楚,注释是补充,不是拐杖。
- 注释是给人看的便条,电脑忽略
- 好注释解释“为什么”,不是“是什么”
- 函数要注释干什么、参数、返回
- 临时方案标 TODO 提醒以后改
- 改了代码要同步改注释
养成写注释的习惯,是成为好程序员的第一步。你今天写的代码,三个月后可能自己都忘了为什么这么写。留几句注释,未来的你会感谢现在的你。合作时,注释让队友少走弯路;开源时,注释让人看得懂、愿意用。小小的注释,是程序员的“职业素养”。
动手试试
动手玩:用 Scratch 或 Python 写一个小程序(比如算成绩等级)。每段加注释说明“这段干什么”。放三天不看,再拿出来看——有注释是不是一眼就看懂了?再让朋友看你的代码加注释,能不能看懂?体会注释的威力。最后给自己定个“注释小规矩”:函数必注释、复杂逻辑必注释、临时方案标 TODO。
给未来的自己留张便条。——编程小语

