我应该在源代码管理中保留todo列表吗？

我在找出存储编程待办事项列表的最佳方法时遇到了一些麻烦.

我考虑以下几点:

每个项目的源代码管理中的一个待办事项列表

源代码管理中的个人文件夹中的主要待办事项列表(包含常规任务)

你怎么找到的？

你会建议什么？

编辑:

谢谢你的建议.我使用错误跟踪系统(BugTracker.NET)来处理错误和涉及其他人请求的任务,以便他们可以看到状态.我在代码中使用// TODO.

我还有很多关于该做什么的补充说明.您是否也建议将其放入错误跟踪器中(特别是如果无法将它们作为// TODO放入代码中)？

为什么不使用错误跟踪系统？

示例: Bugzilla Mantis Trac

和许多其他人......

你应该在你的代码中保留你的待办事项.与错误跟踪程序相关联.然后你应该使用一个文档生成程序来捕获所有待办事项并将它们写入一个列表,其中包含指向代码相关部分的链接.

Doxygen就是一个很好的例子.鉴于代码中的todo:

// TODO: fix potential non-assigment of var
int my_var;

Doxygen将能够提取此信息(您甚至可以设置任意注释的过滤器,如FIXME BUG LOOK_HERE等)和a)为特定的类/接口留下todo条目,以及b)编译todos的列表完整的项目.

此外,您的待办事项和待办事项列表将受版本控制,并且可以从头开始轻松生成列表(即文档).

所以,总结一下:Doxygen,scm系统(任何将要做的)和bugzilla的组合将让你立即启动并运行.

更新:检查这个git钩子,它会在你的签到中从TODO创建Github问题

关于在代码中是否使用TODO这一问题的一般说明是Good Thing(TM):使用工具的傻瓜仍然是个傻瓜.