Sr. Web Developer
mediabistro.com
US-NY-New York

Justtechjobs.com Post A Job | Post A Resume

How To Document Your PHP classes
Overview of Some Php Documentation Tools
Having all of this on mind I have been looking for what was available and I have discovered some interesting tools like the following ones:
phpSearchdoc is a component of the enzyme project. Since enzyme is a big project there was the need of documenting it. Their developers have been writing their own documentation system and they have been kind enough to release it also as an independent package. The documentation gets first written into a database and then it can be viewed with some PHP scripts as a dynamic web site.
The idea to separate parsing logic from presentation is indeed good, however phpSearchdoc (version 1.01) doesn't have a real parser but looks for keywords anywhere in the source, even within comments. In fact, it really have happened to me to have the word 'function' within my comments, and yes, the parser got fooled by thinking that the words following this word were the function's name. Unfortunately then, I was unlucky to have an apostrophe (') in the same line, and when I was trying to write data into the database, mysql has complained (the apostrophe is used to delimit strings in mysql).
Furthermore it's really difficoult to set up and get it working since it's still in alpha state. And after all it's more a cross reference generator than a documentation system because, as far as I know, you can't add your own comments to functions or methods.
phpxref, as the name suggests seems to be more oriented to the generation of a cross reference than a real documentation. Further it seems to be suited more for a regular procedural programming rather than for object oriented programming.
phpautodoc aims to be for PHP what Javadoc is for Java. It seemed to be the perfect solution for my documentation needs. To try it out I had to compile the CGI version of PHP (I normally use the module version), because the generator is written in PHP. I could compile and install the static executable on a Linux system easily with these commands:
rm config.cache
make clean
./configure
make
cp php /usr/local/bin
[ Next Page ]

[Page 1]  [Page 2]  


Comments:
RE: Too many PHPDocs...Nightowl03/19/03 06:15
phpDocGen: simple and reliable doc generatorwiart10/11/02 04:19
Orcale Connectivity problemFaisal Abbas10/02/02 00:03
apostrophe'sjohn's09/26/02 15:48
doxygenmatej hron09/02/02 12:26
Doc generation can become additional burdenAivar Annamaa08/27/02 03:17
Too many PHPDocs...Luiz Rocha07/15/02 11:16
RE: The best automatic PHP Documentor (NO!)Shanx07/04/02 01:10
phpDocumentor 1.1.0rc2 releasedGreg Beaver06/18/02 12:10
PHPDocumentor 1.0.0 STABLE releasedGreg Beaver05/25/02 13:15
The best automatic PHP DocumentorGreg Beaver05/07/02 03:10
RE: PHPDoc v.2.3.5 releasedBrandon Blackmoor04/28/02 19:01
PHPDoc in PEARTim Gallagher04/05/02 19:52
Php how toMahmood Neshati02/24/02 04:44
Media player control in PHP:Jes02/22/02 08:44
a student admire the authortuan02/03/02 08:45
RE: how to starting the PHP sourceGHAN01/29/02 11:29
WINDOWSJason11/16/01 06:18
Windows98Malcolm Clark09/08/01 04:02
RE: Yet more choiceguibod09/03/01 00:33
RE: PHPDoc v.2.3.5 releasedAndy Chapman07/18/01 01:41
PHPDoc v.2.3.5 releasedChristian Calloway06/14/01 08:12
RE: phpdoc v.2.0jose04/08/01 05:41
cannot reterieve image on web pagevishal03/27/01 06:49
Yet more choiceGeoff Caplan03/16/01 15:40
RE: phpdoc v.2.0Shashank Tripathi03/13/01 01:48
phpdoc v.2.0christian calloway02/08/01 14:27
Try www.phpdoc.deTim Strehle11/29/00 16:38
var tab errorsAaron Oathout11/28/00 14:10
yet another choicechristian10/23/00 23:48
Another ChoiceJoshua Eichorn09/13/00 03:23
RE: no need to compile docs..Stefano Locati09/03/00 04:55
RE: Multiple @class elements?Stefano Locati09/03/00 03:58
RE: Multiple @class elements?Frederic De Leersnijder09/02/00 10:02
Multiple @class elements?Frederic De Leersnijder09/02/00 10:01
Multiple @class elements?Frederic De Leersnijder09/02/00 09:30
shambalaMarek Dlugozima09/01/00 14:28
Thanks!Yamilo08/30/00 11:33
Excellent Article !!Ikke Pe Ikka08/29/00 23:11
no need to compile docs..Keith08/28/00 22:46
install for beginnersLen08/28/00 20:55
RE: Good StuffJeff McDonald08/26/00 22:15
Good StuffJeff McDonald08/26/00 22:14
 

If you are looking for help, please post on the appropriate forum here. Your questions will be answered much more quickly.

Add A Comment:

Name:

Email:

Subject:

Message:

To reduce spam posts, messages are now manually approved

You are not [logged in]. That means your account will not get credit for this post.