A tool to find and fix incomplete source code documentation

Posted by Pekka on Stack Overflow See other posts from Stack Overflow or by Pekka
Published on 2009-12-20T17:08:25Z Indexed on 2010/04/08 21:13 UTC
Read the original article Hit count: 358

Filed under:
|
|
|
|

I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style.

While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints, interested in tools to help me automate the task as much as possible.

The tool I am thinking about would ideally have the following features:

  • Parse a PHP project tree and tell me where there are undocumented files, classes, and functions/methods (i.e. elements missing the appropriate docblock comment)

  • Provide a method to half-way easily add the missing docblocks by creating the empty structures and, ideally, opening the file in an editor (internal or external I don't care) so I can put in the description.

Optional:

  • Automatic recognition of parameter types, return values and such. But that's not really required.

The language in question is PHP, though I could imagine that a C/Java tool might be able to handle PHP files after some tweaking.

Thanks for your great input!

© Stack Overflow or respective owner

Related posts about php

Related posts about java