常用的 TODO 标记
常用的 TODO 标记列举如下(摘自Ruby Coding Style Guides):
- 使用 TODO 来备注缺失的特性或者在以后添加的功能。
- 使用 FIXME 来备注有问题需要修复的代码。
- 使用 OPTIMIZE 来备注慢的或者低效的可能引起性能问题的代码。
- 使用 HACK 来备注那些使用问题代码的地方可能需要重构。
- 使用 REVIEW 来备注那些需要反复查看确认工作正常的代码。
使用其他自定义的关键字,如果你认为它是合适的,但是确保在你的项目的 README 或者其他的地方注明。