主要观点:不同团队对代码库中 TODO 注释的处理方式不同,不应强制将其记录在 bug 追踪器或自动删除过久的 TODO。TODO 注释有价值但不一定需要完成,好的 TODO 更像记录边缘情况或建议更好结构,而非实际要做的计划,适当的 TODO 能回答未来读者的疑问,避免因担心改动原有代码而保留不当代码。
关键信息:一些团队要求记录 TODO 到 bug 追踪器,有的自动删除一年以上“过时”TODO;TODO 注释不一定要完成才有价值;好的 TODO 记录边缘情况或建议;能回答未来读者疑问。
重要细节:如“// TODO: Write the second half of this file so next week's launch won't explode”应跟踪,“// TODO: If the user triple-clicks this button, the click handler errors because [xyz]”则是好的 TODO 形式;TODO 有时有用有时无用。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。