Standard ways of doing PHP documentation

[tomath2o]

Hello,

I am wanting to do some good documentation
for my PHP project.

Are there any templates, or standard
ways of doing this, in common use?

I am thinking of something like javadoc
for Java.

Question applies to design documentation,
code file headers, etc.

Tom

[mithril]

Tom,

Check out PHPDoc: http://www.callowayprints.com/phpdoc/. This is JavaDoc for PHP🙂 Basically, you just need to comment you code using JavaDoc notation. PHPDoc then converts the PHP code to Java and passes it to the JavaDoc engine. You'll need to have JDK 1.2 or higher installed to run it. I've used PHPDoc for a couple of my classes and find it pretty good. You can check out modified versions of those docs at http://www.mithril.com/api/ to see if it's want you're thinking of. HTH

geoff

[Anon]

Thanks for your reply Geoff,
sounds like it's just what I want.
I will look into it.

Tom