views:

473

answers:

4

I've written a fair few php apps in the past, but tonight is my first foray into SVN so I figured I'd also document my code properly. What's the adopted format for documenting php functions?

Obviously I could adopt my own format, but, looking forward, if there's one which can be used by documentation tools then all the better.

Cheers!

+8  A: 
Alister Bulman
Why are you using a find command to determine what's changed? Isn't there a source control system for that?
Alex
I would still have to check when they last changed, and grep out the files I don't care about.
Alister Bulman
+1  A: 

PHPDoc

http://phpdoc.org/

based off of Javadoc.

Jaymon
+2  A: 

I am not aware of a standard, but you can use phpDocumentor for auto-documentation.

dbrien
PhpDocumentor is also used by the PEAR and Zend projects, so it's as close to a standard as you can get.
Michael Johnson
+1  A: 

There is no one solid standard for documenting PHP. If you are working with a CMS or Framework check their documentation for any special documentation methods.

If you are looking for a suggestion for a project, the most common method I've seen in Open Source is to use PHPDoc.

Matt Farina