self documenting code?

PHP programming forum. Ask questions or help people concerning PHP code. Don't understand a function? Need help implementing a class? Don't understand a class? Here is where to ask. Remember to do your homework!

Moderator: General Moderators

Post Reply
kingconnections
Forum Contributor
Posts: 137
Joined: Thu Jul 14, 2005 4:28 pm

self documenting code?

Post 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
User avatar
Luke
The Ninja Space Mod
Posts: 6424
Joined: Fri Aug 05, 2005 1:53 pm
Location: Paradise, CA

Post by Luke »

kingconnections
Forum Contributor
Posts: 137
Joined: Thu Jul 14, 2005 4:28 pm

Post by kingconnections »

sweet!!! Thanks ninja!
crazy8
Forum Commoner
Posts: 29
Joined: Fri Dec 22, 2006 12:19 pm

Post 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?
User avatar
John Cartwright
Site Admin
Posts: 11470
Joined: Tue Dec 23, 2003 2:10 am
Location: Toronto
Contact:

Post 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!
User avatar
Luke
The Ninja Space Mod
Posts: 6424
Joined: Fri Aug 05, 2005 1:53 pm
Location: Paradise, CA

Post by Luke »

http://www.phpdoc.org/

EDIT: sorry... I hit refresh and it reposted this :oops:
User avatar
Chris Corbyn
Breakbeat Nuttzer
Posts: 13098
Joined: Wed Mar 24, 2004 7:57 am
Location: Melbourne, Australia

Post 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.
Post Reply