views:

58

answers:

2

Hi just as the title suggests i am looking for the best way to document groups of requires or includes in a php class file. Should each require be documented and are there any phpdoc tags that should be used specifically.

A: 

All include and require files should be documented at the top of the file Check out the @category tag to group them together.

MANCHUCK
+1  A: 

There are many documentation tools available. you can try any of them.

JSDoc, phpDocumentor, OraDoclet, doxygen, phpdoc, PHPxRef.

I personally use doxygen or phpDocumentor

Ghost