Home arrow PHP arrow Page 7 - Writing Self-Documenting PHP Code

Closing Time - PHP

Are you the kind of person who hates documenting your sourcecode? Does the thought of writing API documentation make your eyeballscontract and your toes itch? Well, itch no more - this articledemonstrates how you can use PHPDoc to automatically generate APIdocumentation using the comments in your source code.

  1. Writing Self-Documenting PHP Code
  2. Speaking In Tongues
  3. Drilling Deeper
  4. I, Robot
  5. Tonight's Menu
  6. Different Strokes
  7. Closing Time
By: Harish Kamath, (c) Melonfire
Rating: starstarstarstarstar / 14
April 15, 2002

print this article


And that's about it from me. As you can see, tools such as the ones discussed in this article can substantially reduce the time you spend documenting your code...so long as you remember to comment your code correctly. If you can manage that - and you should be able to - then say goodbye to those long hours writing API documentation, and say hello to the brave new world of PHPDoc and its brethren.

In case you're interested in learning more about the technologies discussed in this article, consider visiting the following links:

The JavaDoc Web site, at http://java.sun.com/j2se/javadoc/

The PHPDoc Web site, at http://www.phpdoc.de/

The eZ phpdoc Web site, at http://developer.ez.no/

The eZ phpdoc tutorial, at http://publish.ez.no/article/articleprint/29/

Till next time...be good!

Note: All examples in this article have been tested on Linux/i586 with PHPDoc 1.0b, Apache 1.3.20 and PHP 4.1.1. Examples are illustrative only, and are not meant for a production environment. Melonfire provides no warranties or support for the source code described in this article. YMMV!

>>> More PHP Articles          >>> More By Harish Kamath, (c) Melonfire

blog comments powered by Disqus
escort Bursa Bursa escort Antalya eskort


- Hackers Compromise PHP Sites to Launch Attac...
- Red Hat, Zend Form OpenShift PaaS Alliance
- PHP IDE News
- BCD, Zend Extend PHP Partnership
- PHP FAQ Highlight
- PHP Creator Didn't Set Out to Create a Langu...
- PHP Trends Revealed in Zend Study
- PHP: Best Methods for Running Scheduled Jobs
- PHP Array Functions: array_change_key_case
- PHP array_combine Function
- PHP array_chunk Function
- PHP Closures as View Helpers: Lazy-Loading F...
- Using PHP Closures as View Helpers
- PHP File and Operating System Program Execut...
- PHP: Effects of Wrapping Code in Class Const...

Developer Shed Affiliates


Dev Shed Tutorial Topics: