Forum Moderators: coopster

Message Too Old, No Replies

php documentation generator

what php documentation generator is everyone using these days and why?

         

jshanman

3:48 pm on Aug 13, 2009 (gmt 0)

10+ Year Member



Hi, We am in the middle of a big project with php and we decided it is a good time to get all our functions documented in an standard format so we can generate a HTML version of the API.

I looked in wikipedia on the "Comparison_of_documentation_generators" page and found a lot that are "compatible" with php. Most articles I can find on the subject were written in 2002, I can't find any recent recommendations. It would also be nice if it were compatible with javascript as well, but that is not 100% necessary.

So, what is everyone using these days and why?
Apple's HeaderDoc looked extensive and well maintained. Anyone have experience with this or have a better alternative?

Thanks.

jatar_k

5:43 pm on Aug 13, 2009 (gmt 0)

WebmasterWorld Administrator 10+ Year Member



I've used phpdoc, it was quite good but it looks a bit inactive now

[phpdoc.org...]

penders

3:52 pm on Aug 19, 2009 (gmt 0)

WebmasterWorld Senior Member 10+ Year Member Top Contributors Of The Month



I've used the same, phpDocumentor (phpdoc.org). It's written in PHP, so can run on the webserver or the command line (I prefer the command line). Supports (Apples?) DocBook format.

A lot of other peoples code I've seen use the same comment block (DocBlock) tags, so I would say it was very popular. eg.

/** 
* Echo a string
* @param string $myString Pass string to be echo'd
*/
function echoString($myString) {
echo $myString;
}

Not sure about JavaScript though.