【问题标题】:How do I mark and label "To-Do"s?如何标记和标记“待办事项”?
【发布时间】:2017-05-19 16:45:11
【问题描述】:

我如何直接在我的代码中清楚地标记和标记“待办事项”(在 Mac 上使用 Atom)以供以后使用?

【问题讨论】:

  • 写一个失败的测试?在您的情况 2 中,惯用异常是 NotImplementedException
  • 我使用#TODO,然后在命令行中使用grep -n 以行号(-n)列出它们。那是如果你在 Linux 上的话。
  • @TadhgMcDonald-Jensen 这个问题不适合那里,原因与这里相同。请不要推荐您不熟悉的网站。见What goes on Software Engineering (previously known as Programmers)? A guide for Stack Overflow
  • @gnat 我已经看过并阅读了那篇文章,我已经阅读了该网站的主题帮助并查看了一些热门问题。我不认为这个问题对于任何一个站点来说都是题外话,并且仍然认为它与软件工程更接近。我承认我的意思是“stackoverflow 更多的是关于 技术 问题”,我说的是“基于目标”,这取决于我。
  • @gnat 我认为它不适合这个网站。这是一个关于主题的 IDE 问题。不过,由于删除了 cmets,我似乎也缺少一些上下文。

标签: python python-2.7 atom-editor todo


【解决方案1】:

我只想用# TODO 标记你的 cmets。大多数 IDE 都有将这些 cmets 聚合到一个列表的方法。 Atom 也不例外,尽管您需要安装 a plugin for it

【讨论】:

  • 插件运行良好!某些语法主题也让 TODO 在 Atom 中更加突出,例如“Solarized Dark”
  • 语法高亮是免费的。
【解决方案2】:

这并不能严格满足您不使用 cmets 的要求,但大多数 IDE 都支持“Todos”。只需用“todo”开始评论:

# TODO: Fix this code!

在许多 IDE 中,这会导致注释被标记为某种明亮的颜色(IntelliJ 中的浅蓝色),并将其放入 TODO 部分以便以后查看。这也会影响诸如 Git 提交之类的事情。如果我尝试提交包含 TODO 的代码,我会收到警告。

【讨论】:

    【解决方案3】:

    我使用inputs 来描述周围的代码/需要做什么,它们会停止执行以明确需要做什么,同时允许您继续。

    【讨论】:

      猜你喜欢
      • 2023-03-12
      • 1970-01-01
      • 2012-06-08
      • 1970-01-01
      • 2019-06-16
      • 1970-01-01
      • 1970-01-01
      • 2019-08-22
      • 2015-12-25
      相关资源
      最近更新 更多