TODO会议来自哪里?

时间:2012-02-29 12:17:47

标签: coding-style convention todo

我怀疑此问题之前已被问过,但谷歌并不容易。

我是一个相当新的编码器,我看到很多代码,有很多不同的语言,评论以“TODO”开头。

问题:

  • 人们在所有这些不同的语言中编写TODO还是仅仅是一种惯例,是否有实际的理由?
  • 如果是后者,会议的来源是什么?

我可以理解为什么能够为TODO进行grep是有用的,我只是对它背后的历史感到好奇。

6 个答案:

答案 0 :(得分:4)

编程是一项全球活动;有助于平滑与非母语人士互动的人们合作的过程非常值得用金子来衡量。 TODOXXX经常被IDE强调,这为坚持使用这些选项提供了极好的动力。

XXX表明维护程序员必须注意的危险或危险; TODO解释了很难解决的缺点。

答案 1 :(得分:2)

TODO意味着“要做”。某人需要的事情。只是猜测,但这猜错了吗?

答案 2 :(得分:2)

快速跟进原始答案: 这个功能主要是一个引用,你可以在Frameworks中找到它,如果有些项目对正在运行的代码没有害处,但开发人员想要解决的问题。

关于现代IDE的好处,例如我使用JetBrains PHPStorm,他们实际上高度关注TODO并将它们放入整个项目的工具栏中,这样您就可以看到所有文件的所有TODO按其目录和文件名区分。

无论如何,只是想到这可能会进一步说明为什么你可以在整个代码中看到它。

答案 3 :(得分:0)

For example,这是Python语言的第一手标准:Mnemonics

答案 4 :(得分:0)

这是一篇关于TODO约定的很好的信息

https://medium.com/imdoneio/5-ways-using-todo-comments-will-make-you-a-better-programmer-240abd00d9e4

文章中的特别要点:

让您的团队保持最新状态,而无需留下代码:

如果您尝试过imdone,就会知道TODO注释可以创建更新并关闭GitHub问题。假设您的评论看起来像这样……

// TODO:完整的结帐控制器+杂务 如果您正在运行imdone-atom,它将被拾起并创建GitHub问题。

// TODO:完整的结帐控制器+任务ID:8 GH:4 完成此任务后,只需将令牌更改为DONE即可。

//完成:完整的结帐控制器+任务ID:8 gh:4 现在,GitHub问题将关闭。当您准备提交代码时,只需使用imdone面板删除注释即可。我敢肯定,您每次需要更新问题时都切换到浏览器窗口,将不会使您分心。

答案 5 :(得分:0)

我知道这个问题已经很久了,但我只是在想这个问题,在网上搜索了一下,这是最好的结果之一。

除了关于 grepping、编辑器/IDE 识别等的评论。我认为 TODO 成为标准的一个重要原因,而不是说 todoToDo , 只是 TODO 是一个大待办事项。