RE: [PHP] [ANNOUNCE] TODO parser

> -----Original Message----- > From: Gregory Beaver [mailto:greg@chiaraquartet.net] > Sent: Saturday, April 28, 2007 1:03 PM > To: Edward Vermillion > Cc: Daevid Vincent; 'PHP' > Subject: Re: [PHP] [ANNOUNCE] TODO parser > > Edward Vermillion wrote: > > > > On Apr 27, 2007, at 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. > >> > > > > [snip] > > > > Doesn't phpDocumentor (http://phpdocu.sourceforge.net/) do > that already? > > Hi, > > phpDocumentor processes @todo tags in a docblock, but not //TODO or > other similar things. > > Greg > -- I believe you're right. Plus I didn't want to have to go through and install PHPDocumentor, and have to follow their PHPDoc conventions and all that crap just to get a 'TODO' list. Programmers are often lazy, so even if *I* were to follow those conventions (which I do actually), many people on my team don't. Also, PHPDocumentor is only good for documenting methods, functions, etc. It won't handle the case where you have: $foo = 1; //TODO: make this something useful later AFAIK, PHPDocumentor only looks in the comment block like this: /* This method does something interesting * * @param int $foo * @todo make this something useful later */