phpdoc

Is it really necessary do something like this: /** * ... * * @return void */ I have quite a few methods that don't have a return value, and it seems really redundant to put something like this in the comment. Would it be considered bad form to leave it out? Jonathan Fingland If it makes it clear for the documentation, then leave it in, but it isn't strictly necessary. It's an entirely subjective decision. Personally, I would leave it out. EDIT I stand corrected. After a little googling, the wikipedia page says: @return [type description] This tag should not be used for constructors or methods

Is there a syntax for documenting functions which take a single configuration array, rather than individual parameters? I'm thinking specifically of CodeIgniter-style libraries, which use a mechanism similar to this: <?php // // Library definition // class MyLibrary { var $foo; var $bar; var $baz; // ... and many more vars... /* Following is how CodeIgniter documents their built-in libraries, * which is mostly useless. AFAIK they should be specifying a name * and description for their @param (which they don't) and omitting * @return for constructors */ /** * @access public * @param array *

I use several associative arrays in my PHP application and I'm using PHP documentor to comment my sources. I never really did specify comments for the arrays in an array, but now I need to do that and don't know how. $array = array('id' => 'test', 'class' => 'tester', 'options' => array('option1' => 1, 'option2' => 2)) How do I comment this array in the correct way for @var and @param comments? I could do this like this, but I don't know if this is correct: @param string $array['id'] @param string $array['class'] @param int $array['options']['option1'] But how to do this for the @var part? You

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)