3.2.1. 不要注释不好的代码,将它重写
Don’t comment bad code — rewrite it — Brian Kernighan
粗劣的代码的注释高亮显示是不够的。 如果你遇到其中一条注释,则应提出问题,以提醒您稍后重构。 只要技术债务数额已知,它是可以忍受的。
标准库中的惯例是注意到它的人用 TODO(username)
的样式来注释。
// TODO(dfc) this is O(N^2), find a faster way to do this.
注释 username
不是该人承诺要解决该问题,但在解决问题时他们可能是最好的人选。 其他项目使用 TODO
与日期或问题编号来注释。