SiteMinder / Webhosting
The Computer Merchant, Ltd
US-MA-North Quincy

Justtechjobs.com Post A Job | Post A Resume

How To Document Your PHP classes
So you've read about how Object Oriented programming can help you with your big web projects and you've started it using with PHP? If you've already written a handful of classes to implement a site and you're methodic, then you should have written some documentation about them. But If you're just messy like me you've just written some comments within the classes' source and no other documentation. Without documentation it's difficult to remember methods' names and the way they have to be used (parameters and meaning). The typical way to solve this situation is to have source code files open and to skim through hundreds or thousands of lines.
Javadoc Like Documentation
There must be a better way -- if you are used to the Java language you will know the Javadoc documentation system. This tool allows you to insert tags within comments of your source files that are then parsed by Javadoc tools in order to generate a set of HTML pages documenting your classes. So while you program you can keep your browser open and you'll have a list of your classes and methods with descriptions. This will become your reference to be more productive and fast while building your web application.
In my opinion maintaining a documentation as a reference within source code is easier and more practical than having to do it in a separated document because in this way it's easier to keep it updated. Otherwise it's very easy to become lazy and postpone updates in the documentation to a time that never comes. Instead with a tool like this there is the little burden to update a tag near the source code you've just modified and to run the tool to generate again the updated html pages.
[ Next Page ]


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.