Task List comments in Visual Studio
Here’s a quick Visual Studio tip. You can embed useful notes and reminders in code using Task List comments like this:
// TODO: fix catastrophic memory leak
These notes will automatically appear in the Visual Studio Task List, which you can open with the shortcut Ctrl+W, T or by selecting View – Task List from the main menu bar.
Visual Studio also supports two other comment tokens, HACK and UNDONE. You can even add your own custom comment tokens in:
Options – Environment – Task List.
about 3 years ago
KLUDGE or KLUGE are good ones for custom comments. Pretty much the same as HACK.
about 2 years ago
That’s a damn good tip for a n00b like myself.
about 2 years ago
i agree with vaughany, that is quite useful
about 2 years ago
I just wish you didn’t have to actually OPEN the file to view the comments in the task list. I wish I could have an option to view all.
about 2 years ago
For some reason VB.NET will show tasks from files that aren’t currently open but other languages (C#) only show tasks from open files. I’ve also found that C# won’t show lines that are preprocessed out (I don’t know if this is the case for other languages).
For example, if you have
#if DEBUG
// HACK: do not release!
veryBadMethod();
#else
// TODO: figure out an alternative to veryBadMethod()
#error no replacement yet for veryBadMethod()
#endif
The “HACK” comment in DEBUG will only show when the active configuration is debug, and the TODO will only show when the active configuration is release