Menu
is there a way to list ToDo comments in rstudio?
Before I used eclipse and really loved to put some # TODO I definitely need more unit tests here! comments in my source code.
I could not find this feature in rStudio so far and I was wondering, if there is something like a plugin or maybe an easy way of searching such comments.
567
TODO comments are just code comments that start with a single string of capital letters like // TODO or // FIXME. Most of the TODO comments in your code are probably sitting unattended and forgotten in your team or organization's source code.
To create a TODO commentPlace the caret where you want to create a TODO item and add a comment, for example, by pressing Ctrl+/ , then type TODO or FIXME , and then type your note.
In general, a TODO is written to tell future maintainers about something important: something that should be added, or should be changed, or should not be forgotten. The intention is often to increase the quality of the code. Sometimes a TODO comment can save you a lot of time!
In the Settings/Preferences dialog ( Ctrl+Alt+S ), select Editor | TODO. Use a regular expression to specify a custom pattern. This matches the word "optimize" ( \b designates word boundaries) and allows any number of other characters in the comment. Then click OK to save the new pattern.
I would suggest that you consider the todor RStudio add-in by dokato. After installing via devtools:
devtools::install_github("dokato/todor")
You will be able to conveniently list ToDo items across your project:
(images and code sourced from: https://github.com/dokato/todor)
183
There is no such system in RStudio, but there is an easy way of searching for the comments. Do this:
^\s*# TODO
That regular expression will match any line that starts with # TODO.
33
You can use the outline list by having:
# TODO I definitely need more unit tests here! ####
Just keep in mind that you have to have 4 '#' at the end of the line
30
If you work with git and the files are tracked you can use
git grep TODO
in the terminal (which is also included in the Rstudio IDE) to get a list of your TODOs.
31
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
