|Just another Perl shrine|
Re: Suggestions for working with poor codeby knobunc (Pilgrim)
|on May 10, 2001 at 18:19 UTC||Need Help??|
Very cool node.
With regard to the To Do list, I scatter them throughout my code if there is a place I need to do further work. However, I have a make rule for todo that searches for all of the lines with TODO in them and prints them out. So a usage of a TODO:
When run through the following (ugly, suboptimal, but working) code in Tools/todo.sh:
Which I call from my Makefile:
Kinda ugly, but it lets me put the TODO statements where I actually need to do the work. So I can proof out a block of code by writing narrative comments with TODO at the start of the line (behind comment characters of course). Then fill in the code later and not worry about missing a piece. Also since the TODOs are where the stuff needs to be filled in, I have lots of context around the issue and don't need to write as much as I would if they were at the top of the file. Plus anyone without something to do in the group can just type make todo and add some code. Finally, it is easier to add a TODO right where you need it, than bop up to the top of the file and then have to find where you were back in the code.