[ESS] add TODOs into source code?

[Rainer M Krug]

On Wed, Jul 9, 2008 at 11:18 AM, Neil Shephard <nshephard at gmail.com> wrote:
> On Wed, Jul 9, 2008 at 8:41 AM, Rainer M Krug <r.m.krug at gmail.com> wrote:
>> Hi
>>
>> sorry if this is considered off-topic, but I a need this in a larger R
>> project and I am using ESS.
>>
>> I would like to add TODO items to the source code, so that I can
>> identify code which still needs to be changed or to be added. These
>> TODO items should be in linked to lines in the source code and file.
>>
>> Any ideas how I can do that in EMACS / ESS? O am also using ECB.
>
> Could you not just enter comments with 'TODO' at the start?

Yes - that would be possible.

>
> <--- Begin myscript.R --->
> ## TODO
> ##
> ## Optimise the code that follows
> some.R.code()
> <--- End myscript.R --->
>
> If you wanted to identify just the things you need to do then you
> could 'grep -A5 'TODO' to look at the comments that follow your '##
> TODO' line.

Sounds like a good idea.

>
> Or maybe I'm missing something with regards to "linked in to lines"?

Absolutely not - you are spot on.
It is just that I am coming from Delphi programming, where there was a
TODO list included which would show all TODO items from all the files
open.

I am not that used to the emacs way of doing it, but I must say the
solution with grep sounds like a good idea.

Thanks.

Rainer

>
> Neil
>
> --
> "I never think of the future - it comes soon enough."  - Albert Einstein
>
> Email - nshephard at gmail.com / n.shephard at sheffield.ac.uk
> Website - http://slack.ser.man.ac.uk/
> Photos - http://www.flickr.com/photos/slackline/
>



-- 
Rainer M. Krug, PhD (Conservation Ecology, SUN), MSc (Conservation
Biology, UCT), Dipl. Phys. (Germany)

Plant Conservation Unit
Department of Botany
University of Cape Town
Rondebosch 7701
South Africa