Page 1 of 1
What is the best PHP documentation program?
Posted: Wed Sep 01, 2004 1:26 am
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
Posted: Wed Sep 01, 2004 2:04 am
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.
Posted: Wed Sep 01, 2004 3:39 am
by CoderGoblin
I agree go with phpDocumentor.
Be aware that the documentation is easier to do as you code rather than as an "afterthought..."
Posted: Mon Jun 06, 2005 4:55 am
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?
Posted: Mon Jun 06, 2005 5:02 am
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;
}
php manuel
Posted: Sat Jun 25, 2005 3:32 am
by deep_fire
Php manuel answers all your questions

Posted: Sat Jun 25, 2005 2:14 pm
by Buddha443556
For those who use more than one language and know how to compile C.
RoboDoc