What is the best PHP documentation program?

XML, Perl, Python, and other languages can be discussed here, even if it isn't PHP (We might forgive you).

Moderator: General Moderators

Post Reply
myleow
Forum Contributor
Posts: 194
Joined: Mon Jun 21, 2004 7:05 pm
Location: California

What is the best PHP documentation program?

Post by myleow »

I just finished a huge program and wish to document it.

What is the best Documentation program for php, please advice

Regards
Mian
User avatar
patrikG
DevNet Master
Posts: 4235
Joined: Thu Aug 15, 2002 5:53 am
Location: Sussex, UK

Post by patrikG »

phpdocumentor is what I use. Very neat, Java-style documentation. It takes a couple of tries before you've sussed it really out, but after that it's a piece of cake.
User avatar
CoderGoblin
DevNet Resident
Posts: 1425
Joined: Tue Mar 16, 2004 10:03 am
Location: Aachen, Germany

Post by CoderGoblin »

I agree go with phpDocumentor.

Be aware that the documentation is easier to do as you code rather than as an "afterthought..."
malcolmboston
DevNet Resident
Posts: 1826
Joined: Tue Nov 18, 2003 1:09 pm
Location: Middlesbrough, UK

Post by malcolmboston »

sorry to revive such an old topic

I downloaded this yesterday and ran it, it didnt really seem to do much tbh, i set file paths up and setup the output file, i got some files returned that really meant nothing

simple question really, is there anything i need to do BEFORE i run it?
User avatar
patrikG
DevNet Master
Posts: 4235
Joined: Thu Aug 15, 2002 5:53 am
Location: Sussex, UK

Post by patrikG »

read the manual ;)

You need to abide by their commenting style so it can be parsed, otherwise not much happens.

Code: Select all

/**
* @package User
* @version $Id: class_subscription.inc.php,v 0.1 17.03.2005 PatrikG Exp $
*/
/**
* Subscription Class
* @access public
* @package User
*/

class subscription{
    /**
    * user constructor
    * @access      public
    * @param       int $id user-id
    * @param       int $name name of user
    * @return      bool $login User is a subscriber?
    */
function subscription($id,$name){
    $this->name    =   $name;
    $this->id      =   $id;
    ...
    return $this->login;
}
deep_fire
Forum Newbie
Posts: 7
Joined: Fri Jun 24, 2005 2:34 pm
Contact:

php manuel

Post by deep_fire »

Php manuel answers all your questions :lol:
User avatar
Buddha443556
Forum Regular
Posts: 873
Joined: Fri Mar 19, 2004 1:51 pm

Post by Buddha443556 »

For those who use more than one language and know how to compile C.

RoboDoc
Post Reply