rStudio中的TODO注释

Question

有没有一种方法可以在RStudio中列出ToDo注释？
以前我使用过Eclipse，非常喜欢在我的源代码中添加一些# TODO 我绝对需要更多的单元测试！的注释。

到目前为止，我还没有在RStudio中找到这个功能，我想知道是否有类似插件或者搜索这些注释的简单方法。

- drmariod

---

为什么不直接向RStudio提问呢？https://support.rstudio.com/hc/zh-cn - user3710546

谢谢提供链接。我已经查看了，两年前就有人询问过这个问题。看起来现在什么也没有改变。我想知道其他用户是如何处理这些事情的。我认为在其他IDE中这是相当普遍的。RStudio中没有插件系统，对吗？ - drmariod

不错的建议，但在开发包含20个文件的程序包时可能会有些困难。我可能会采用命令行解决方案 find . -type f -name '*.R' -exec grep -Hni 'todo' {} \; 但我认为可能会有更好的解决方案... - drmariod

使用Ctrl-Shift-R（或在OS X上使用Cmd-Shift-R）插入“节”注释，该注释应显示在RStudio函数选择器弹出窗口中。将“TODO”放在那里，就很容易在文件中找到它了。 - hrbrmstr

刚刚安装了RStudio 1.1.423版本，看起来他们实现了一个功能，可以改变代码注释中“TODO”和“FIXME”关键字的文本颜色。 - Brian D

Answer 1

RStudio中没有这样的系统，但有一种简单的方法可以搜索注释。请按照以下步骤：

1. 转到“编辑”->“在文件中查找”
2. 选中“正则表达式”复选框
3. 输入以下正则表达式：^\s*# TODO
4. 点击“查找”按钮

该正则表达式将匹配任何以# TODO开头的行。

- Jonathan

---

哇，从没见过这个选项...太棒了，我还可以点击文件名，直接跳转到评论所在的行...几乎完美！:-) 感谢你的提示。 - drmariod

很奇怪的是，RStudio对于#TODO使用了特殊的语法高亮，但似乎没有其他内置功能与之相关。 - jzadra

实际上，您不需要正则表达式（regex）[仅当您真的希望显示搜索从一行开始的结果时]。如果您使用上面描述的正则表达式，则会失去在任何地方添加评论的可能性，例如在另一个评论之后。事实上，我甚至不会包括 #。只需在文件中查找TODO或FIXME :-) - Aleix

Answer 2

我建议你考虑由 dokato 开发的 todor RStudio 插件。通过 devtools 安装后：

devtools::install_github("dokato/todor")

您将能够方便地在项目中列出待办事项：

（图片和代码取自：https://github.com/dokato/todor）

- Konrad

---

谢谢你的评论。我模糊地记得读过这个将来会在rStudio中实现，还有一些其他关键字，比如FIXME之类的...但是我现在找不到那篇文章了。我会查看这个包，但到目前为止，“在文件中查找”功能非常方便。 :-) - drmariod

Answer 3

您可以通过以下方式使用大纲列表：

# TODO I definitely need more unit tests here! ####

请记住，在行末必须有4个'#'。

- Fabian

---

谢谢，我也是这样使用的。如果对其他人有用的话，可以使用四个破折号“-”作为四个井号的替代。 - icj

Answer 4

如果你使用git并且文件被跟踪，你可以使用

git grep TODO

在终端中（也包括在Rstudio IDE中），输入命令以获取您的TODO列表。

- andschar