“不要对你的代码进行注释，它应该是自文档化的”。嗯……我不同意。

自从我开始写我的第一段代码以来，我听到很多开发者说注释毫无用处，它只是为写出糟糕的代码道歉的一种方式。但在与一个大团队一起参与过一个大项目之后，我唯一能说的就是：不给代码加注释是自恋，而且会排斥初学者。顺便说一句，谁说你的代码像你想象的那样好，那么显而易见呢？是的，你的想法。

工作中，你或许会遇到一个函数，然后自问：“这到底是什么？” 我们很多人都经历过这种情况，即使距离项目结束几周后，我们自己编写的代码也依然如此。现在，想象一下，如果你不必浪费时间在成百上千的文件中寻找需要的函数，你只需在代码中添加注释，说明函数的用途、参数以及返回值即可。生活或许就像一场梦，不是吗？

另外，我们不能想当然地认为每个人都和我们一样思考，而且我们的做法也太明显了。每个人分析事物的方式各不相同，有些人经验不足，甚至有焦虑症和注意力缺陷多动障碍等心理健康问题，这使得理解某些代码片段的过程更加困难。难道我们就不能花一分钟来评论我们的复杂性，就把他们排除在外吗？我认为我们不应该。

问题不在于您是否应该注释您的代码，而在于您需要在代码中注释什么以及应该如何注释。

编写干净且易于阅读的代码是不可或缺的，并且随着经验的积累，您会在这方面做得更好，但您也可以编写干净且良好的注释，因此它可以作为您和其他人的一个参考，而且它不会让你成为一个糟糕的程序员，恰恰相反！它使您成为一个更好的专业人士，您的代码将易于维护，此外，您可以确保无论谁加入您的团队的级别如何，他们都会更快地获得它并开始从事项目，并且如果您不得不离开您的工作，在您之后的开发人员会在每天睡觉前感激您并感谢您。（好吧，我对最后一部分不太确定）。

“程序必须是为了人们阅读而编写的，而只是为了偶然地供机器执行。” - 哈尔·阿贝尔森 - 麻省理工学院教授。

推荐阅读：
编写代码注释的最佳实践

记录 JavaScript 的最佳方法是什么？