Resharper 3.0 EAP in Action – The Todo Explorer

The ReSharper 3.0 EAP has been in progress for about two weeks now. This is the first post in a series that will look in detail at some of the new features that will be available in this latest version of ReSharper.

The To-do Explorer

In Visual Studio.NET 2005, you can use the Task List window to show comments with the keyword todo in it. However, this only works with files that are open in the IDE; it’s not going to show you TODOs in other parts of your solution that you don’t currently have open, or any other keyword EXCEPT todo.
Visual Studio.NET 2005 Tasklist
The Visual Studio.NET 2005 Task List window

In ReSharper 3.0, you get the much more useful To-do Explorer. When you open this window (found in ReSharper -> Windows -> To-do Explorer), by default you see a solution-wide listing of all comments with the prefix NOTE, TODO or BUG.
ReSharper 3.0 ToDo Explorer
The new To-do Explorer window

The default keywords that the To-do explorer looks for can be changed or added to by clicking the “To-do settings” icon in the window.
To-do Explorer settings

In the settings window, you can create new keywords to search for or edit the existing keywords as you’d like. This could be useful, for example, if you have a references to JIRA tickets in your comments, like:
//PROJ-1655: The following code block was added because of a change request from a client
You could add a pattern to match the keyword “PROJ-####” and see all JIRA tickets mentioned in your code.
To-do explorer keyword editing

Editing keywords in the To-do explorer

These To-dos can also be exported to a text file and can also be grouped to make the To-dos easier to read, so you can find which projects, namespaces, directories, etc … contain To-dos.
To-do explorer view options
The To-do Explorer view options

This entry was posted in ReSharper Tips&Tricks. Bookmark the permalink.

9 Responses to Resharper 3.0 EAP in Action – The Todo Explorer

  1. Juergen Mueller says:

    This is a nice feature which could be very useful, if there is a way export the completed work items (for subversion commits).

    I would be much more impressed by a blog post about support for the new Orcas language features. Where’s the beef in the 3.0 release if I’m not stuck in Visual Basic world? :)

    Jürgen

  2. Dag Christensen says:

    “(…)it’s not going to show you(…)any other keyword EXCEPT todo”
    This isn’t correct. The keywords “hack”, “undone” and “todo” are predefined, and you can add/customize keywords using Options -> Environment -> Task list. The requirement that files must be open is a huge drawback though, and I’m looking forward to try your implementation.

  3. jpennal says:

    Juergen:

    I dont believe there is any way to track “completed” work items with the to-do explorer. However, off the top of my head, you could always export the outstanding todos to an xml file, commit that to SVN and then DIFF the files every time you want to see what’s changed.

    As for Orcas, while there are a ton of nice features coming in that release, it’s still not going to be released for a while. On top of that, I think you’d be surprised just how many people are stuff in the Visual Basic world still :)

    Dag:
    Good catch on Visual Studio’s task list keyword customization. :)

  4. dstennett says:

    Juergen:

    If something isn’t implemented or supported the way you’d like, then fill out our little questionnaire at:

    http://www.jetbrains.com/resharper/quest.jsp

    Let the developers know what you want! (or would be helpful!)

  5. Dmitri says:

    Will ReSharper 3 support .NET 3.0 in all its XAML goodness?

  6. jpennal says:

    Dmitry, according to the ReSharper 3.0 EAP roadmap, there is basic support for XAML already. I do not know if the plan is for full XAML support in 3.0, but you can probably expect more XAML support to be added in the near future.

  7. I don’t know if this is the right place to post this, but I’d love it if Resharper 3 gave us full text search on all files in the loaded solution.

    Thanks for a great product!

  8. jokiz says:

    hey andres, what full text search are you talking about?

  9. UL-Tomten says:

    Andres: answer him!

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code class="" title="" data-url=""> <del datetime=""> <em> <i> <q cite=""> <strike> <strong> <pre class="" title="" data-url=""> <span class="" title="" data-url="">