rStudio 中的 TODO 注释

Posted 2023-02-21

【中文标题】rStudio 中的 TODO 注释

【英文标题】：TODO comments in rStudio

【发布时间】：2015-10-30 16:27:36

【问题描述】：

有没有办法在 rstudio 中列出 ToDo cmets？ 在我使用 eclipse 之前，我真的很喜欢在我的源代码中放一些 # TODO I definitely need more unit tests here! cmets。

到目前为止，我在 rStudio 中找不到此功能，我想知道是否有类似插件之类的东西，或者可能是搜索此类 cmets 的简单方法。

【问题讨论】：

为什么不直接询问 RStudio？ support.rstudio.com/hc/en-us

感谢您的链接。我查了一下，两年前，已经有人要求了。从现在开始，似乎什么都没有改变。我想知道，其他用户如何处理这些事情。我认为这在其他 IDE 中很常见。 rstudio里没有插件系统吧？

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

使用 ctrl-shift-R（或 OS X 上的 cmd-shift-R）插入应该显示在 RStudio 函数选择器弹出窗口中的“部分”注释。将“TODO”粘贴在那里，它很容易在文件中找到。

刚刚安装了 RStudio 1.1.423 版，看起来他们已经实现了一个功能，可以更改代码 cmets 中“TODO”和“FIXME”关键字的文本颜色。

【参考方案1】：

我建议您考虑dokato 的todor RStudio 插件。通过devtools安装后：

devtools::install_github("dokato/todor")

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

（图片和代码来源于：https://github.com/dokato/todor）

【讨论】：

感谢您的评论。依稀记得看过，反正在不久的将来会在 rStudio 中实现，还有一些其他的关键字，比如FIXME 左右……但我暂时找不到这篇文章。我会看看这个包，但到目前为止find in files 非常方便。 :-)

【参考方案2】：

RStudio 中没有这样的系统，但是有一种搜索 cmets 的简单方法。这样做：

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

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

【讨论】：

呃哇，以前没见过这个选项...太好了，我也可以点击文件名，也可以直接点击评论所在的行......几乎完美！ :-) 感谢您的提示。

奇怪的是，RStudio 为#TODO 使用了特殊的语法高亮显示，但似乎没有任何其他内置功能。

【参考方案3】：

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

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

请记住，您必须在行尾有 4 个“#”

【讨论】：

谢谢，我也是这么用的。如果这与其他任何人相关，可以使用四个破折号- 作为四个主题标签的替代品

【参考方案4】：

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

git grep TODO

在终端（也包含在 Rstudio IDE 中）中以获取您的 TODO 列表。