Uh...check what?
-
I'm glad he put the exclamation marks in there. That made me realise this wasn't just another comment, it was something important that I can't ignore. Maybe IDEs should include a feature that allows you to scan for comments that include exclamation marks, because that means they must be important! And comments in upper case with two exclamation marks must be really IMPORTANT!! In fact, this comment must be incredibly important because it has an uppercase IMPORTANT!! and three exclamation marks in total! Too bad it wasn't important enough to fix.
> Maybe IDEs should include a feature that allows you to > scan for comments that include exclamation marks, because > that means they must be important! IDE's do have that feature, although Visual Studio went with the needlessly verbose 'TODO' rather than the more pithy ! I wonder what percentage of Visual Studio programmers know that it has a Task List feature? Might make a good interview question actually.
-
> Maybe IDEs should include a feature that allows you to > scan for comments that include exclamation marks, because > that means they must be important! IDE's do have that feature, although Visual Studio went with the needlessly verbose 'TODO' rather than the more pithy ! I wonder what percentage of Visual Studio programmers know that it has a Task List feature? Might make a good interview question actually.
-
> Maybe IDEs should include a feature that allows you to > scan for comments that include exclamation marks, because > that means they must be important! IDE's do have that feature, although Visual Studio went with the needlessly verbose 'TODO' rather than the more pithy ! I wonder what percentage of Visual Studio programmers know that it has a Task List feature? Might make a good interview question actually.
Actually, the task list is token-based, defined from the Tools->Options->Task List->Tokens panel. For interest's sake, I just tried to add !!! as a token name. No love (invalid chars). IMPORTANT, however, just turned up three more instances...
-
> Maybe IDEs should include a feature that allows you to > scan for comments that include exclamation marks, because > that means they must be important! IDE's do have that feature, although Visual Studio went with the needlessly verbose 'TODO' rather than the more pithy ! I wonder what percentage of Visual Studio programmers know that it has a Task List feature? Might make a good interview question actually.
Yes, I'm also familiar with NetBeans and Eclipse in the Java world, both of which allow you to put comments in like TODO or FIXME or indeed anything you want and associate that with a priority in the task list. There is also Checkstyle which is a Java tool for checking source code and one of the things it can scan for is TODO comments, etc. It just happens to be a personal bug-bear for me, the way developers throw exclamation marks all over the place. How often have we seen error messages like:
File not found!
What exactly is the developer trying to convey to the user by including that exclamation mark? The file was not found - surprise! Or maybe: The file was not found - Oh My God! Or: The file was not found - HA HA HA!
-
Yes, I'm also familiar with NetBeans and Eclipse in the Java world, both of which allow you to put comments in like TODO or FIXME or indeed anything you want and associate that with a priority in the task list. There is also Checkstyle which is a Java tool for checking source code and one of the things it can scan for is TODO comments, etc. It just happens to be a personal bug-bear for me, the way developers throw exclamation marks all over the place. How often have we seen error messages like:
File not found!
What exactly is the developer trying to convey to the user by including that exclamation mark? The file was not found - surprise! Or maybe: The file was not found - Oh My God! Or: The file was not found - HA HA HA!
David, I don't know about anyone else, but you've convinced me. A bit of work to do over the weekend, but by Monday my coding standards will have a new section called Smilies! ' File Not Found :^) ' File Not Found :~ ' File Not Found :-\ ' File Not Found :doh: ' File Not Found :confused: I'm amazed this isn't standard practice already. -Richard
-
Unfortunately, in VS, the Task List for TODOs is glitchy and doesn't show everything. If you use R#, it has a much better To-Do explorer that includes TODOs, NOTEs, and my favourite NotImplementedExceptions!
GibbleCH wrote:
the Task List for TODOs is glitchy and doesn't show everything
I'm pretty sure you have to have the file open to see the TODO comments in the task list.
-
David, I don't know about anyone else, but you've convinced me. A bit of work to do over the weekend, but by Monday my coding standards will have a new section called Smilies! ' File Not Found :^) ' File Not Found :~ ' File Not Found :-\ ' File Not Found :doh: ' File Not Found :confused: I'm amazed this isn't standard practice already. -Richard
-
I use an "int __todo_description;" instead. Gives me a compiler warning. Now I only need to get rid of these 205 warnings :^)
easier: #warning super cali fragilistic expi ali docious
A train station is where the train stops. A bus station is where the bus stops. On my desk, I have a work station.... _________________________________________________________ My programs never have bugs, they just develop random features.
-
easier: #warning super cali fragilistic expi ali docious
A train station is where the train stops. A bus station is where the bus stops. On my desk, I have a work station.... _________________________________________________________ My programs never have bugs, they just develop random features.
Super Lloyd wrote:
#warning super cali fragilistic expi ali docious
If my code would be in C#, I would use the #warning pragma :) int __todo; is the only way I've found that works between different C++ compilers.
-
David, I don't know about anyone else, but you've convinced me. A bit of work to do over the weekend, but by Monday my coding standards will have a new section called Smilies! ' File Not Found :^) ' File Not Found :~ ' File Not Found :-\ ' File Not Found :doh: ' File Not Found :confused: I'm amazed this isn't standard practice already. -Richard