编写注释

  • 注释固然很重要, 但最好的代码应该就是文档本身。有意义的类型名和变量名, 要远胜于用注释去解释含糊不清的名字。注释应当解释代码为什么要这么做以及其目的。

  • 不要描述显而易见的现象,永远不要使用自然语言翻译代码作为注释,除非对高手来说此代码的主要功能都容易被忽略。在写注释时要假设读代码的人水平都高过于你。

  • TODO 是注释中很有用的一个,可以标记一些未完成的或不尽如人意的地方,空闲时就可以在 IDE 中顺着完成。

  • 注释应该尽量使用项目维护人员的母语或常用语。

作者:Vanessa 链接:https://hacpai.com/article/1551338654162 来源:黑客派 协议:CC BY-SA 4.0 https://creativecommons.org/licenses/by-sa/4.0/