Skip to content

Latest commit

 

History

History

README.md

什么样的注释是好的

标记 含义
TODO 等待处理的事情
FIXME 已知无法运行的代码
HACK 对一个问题不得不采用的简单粗暴的方案
XXX 危险,这里有严重的问题

该写什么样的注释

注释的目的是帮助读代码的人了解作者在写代码时的思想。

什么地方不需要注释:

  • 能从代码本身中快速推断的事实
  • 用来装饰垃圾代码(比如拗口的方法名),实际上应该把名称修改好

记录你的想法

  • 为什么代码写成这样而不是另一个样子的内在理由(“指导性批注”)
  • 代码中的不足,使用像 TODO 或者 XXX 这样的标记
  • 常量背后的意义,为什么是这个值?

在读者的立场思考

  • 预料到代码中哪些部分会让读者说:“哎嘿?什么鬼” 给它们加上注释
  • 为小白意料之外的行为加注释
  • 在文件、类级别上使用“全局观”注释来解释所有的部分是如何一起工作的
  • 用注释总结代码块,让读者不会迷茫在细节里