documentation - How do you document your PHP functions and classes inline?

Question

(Closed). This question is opinion-based. It is not currently accepting answers. question from:https://stackoverflow.com/questions/1182781/how-do-you-document-your-php-functions-and-classes-inline

Answer 1

PHPDoc, like what you've posted, is a widely accepted form of PHP documentation.

You can use Doxygen to auto-generate the docs.

Edit: In terms of generating in-line documentation in your code, I have never come across a tool that will go back and do this externally for a project. It's generally left in the realm of the IDE to generate a template while you code.

Eclipse actually does a decent job of this (it's one of the few things I like about Eclipse) and I believe Netbeans does as well. Any major IDE will likely have functionality to assist with this type of template generation.