Page 1 of 1

self documenting code?

Posted: Fri Jan 12, 2007 2:20 pm
by kingconnections
I remember I used to use something called JavaDoc. I used comments to automate documentation of your code. Is there anything like this for php?

Thanks

Dan

Posted: Fri Jan 12, 2007 2:23 pm
by Luke

Posted: Fri Jan 12, 2007 2:30 pm
by kingconnections
sweet!!! Thanks ninja!

Posted: Fri Jan 12, 2007 2:33 pm
by crazy8
Ok im curious. I went to the site and just glanced at some of the features and stuff but what exactly is this? In what cases whould someone use this? What exactly is it for and do?

Posted: Fri Jan 12, 2007 2:43 pm
by John Cartwright
From their own website,
Writing good documentation is essential to the success of any software project. The quality of documentation can be even more important than the quality of the code itself, as a good first impression will prompt developers to look further into your code. phpDocumentor is designed to make it easier to create documentation. phpDocumentor even makes it possible to generate separate sets of documentation from the same source!

Posted: Fri Jan 12, 2007 2:46 pm
by Luke
http://www.phpdoc.org/

EDIT: sorry... I hit refresh and it reposted this :oops:

Posted: Fri Jan 12, 2007 4:13 pm
by Chris Corbyn
You need to run the phpdocumentor code to use it. You might wanna look at doxygen since that's a bit more universal across languages.

Most of the reason I use DocBook comments in any language I use is for the purpose of those reading the code at the time.