My tool is case insensitive. It looks for all of these and more: //TODO # TODO @TODO With or without spaces and other extra characters It's smart enough to know the difference between $todo = 1; //TODO: it will match this text, but not the variable It won't match this: <title>TODO list</title> It knows if it's in a <?php ?> block and only parses that. It does not handle multiple line todo items like this: //TODO: [dv] it really should handle multiple line to do items // well maybe in v2.0 I'll get to that. // most people say the important part in the first line anyways Trust me. I wouldn't have written the tool if I didn't think there was a need -- at least there is for me. It's free. Use it if you like, or don't. Just thought I'd share it... d > -----Original Message----- > From: Richard Lynch [mailto:ceo@xxxxxxxxx] > Sent: Saturday, April 28, 2007 12:52 PM > To: Daevid Vincent > Cc: 'PHP' > Subject: Re: [ANNOUNCE] TODO parser > > Personally, I always spell it 'todo' and then a simple grep works > pretty well... > > I suppose I sometimes find a bunch of stuff with 'todo' in a variable > name, but not real often, so far... > > I also tend to keep a "todo.txt" file open and add to that instead of > strewing things through my code... > > The only "todo" items in code are super super minor and so specific to > that bit of code that I can't come up with a context-free way to > express it in a sentence or less... > > Certainly any big-ticket items in a ToDo list deserve to be in an > actual list rather than buried in source somewhere, no? > > On Fri, April 27, 2007 8:24 pm, Daevid Vincent wrote: > > For a long time I've wanted a tool that would traverse my > source code > > to > > find all those little forgotten "TODO" entries. > > > > It should handle most all kinds (as you'll see if you look at the > > example > > files). The only one I didn't bother with was: > > > > $foo = 1; //Todo: [dv] I meant todo this later. > > > > notice the 'todo' in there. it confuses my script. simple > solution is > > just > > spell it out as 'to do', which is proper English anyways! > > > > I give you a fairly simple but useful tool that does just that. The > > output > > can be command line (preferred way) or CSV so you can > easily parse it > > into a > > web page. I provided an example of how to do that. The web > version of > > course > > could be made much more interesting, with hyperlinks to the files, > > color, > > etc, but I wanted to keep it simple for illustration purposes. > > > > http://daevid.com/examples/todo/ > > > > Having said that, you should download it and try it for yourself. > > > > ./todo.php --path ./example --parse_tree > > > > ./todo.php --help for more options > > > > It's all in a single todo.php file so it's easy to add to > > /usr/local/bin or > > whatever. > > The tgz is really only for the examples. > > > > ÐÆ5ÏÐ > > > > P.S. While you're there, I'll give a plug to my DHCP web > tool. Perfect > > for > > seeing who's on your LAN. > > http://daevid.com/examples/dhcp/ > > > > > > > -- > Some people have a "gift" link here. > Know what I want? > I want you to buy a CD from some indie artist. > http://cdbaby.com/browse/from/lynch > Yeah, I get a buck. So? > > -- > PHP General Mailing List (http://www.php.net/) > To unsubscribe, visit: http://www.php.net/unsub.php > > -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
