PHPDoc - http://www.phpdoc.de/
   Home - Documentation - Doc Comments 
 
   Home 

 About PHPDoc 
 Demo 
 Documentation 
   Introduction 
   Installation 
   Usage 
   Doc Comments 
 Download 
 CVS 
 Feedback 
 Known Bugs 

   Doc Comments

A Doc Comment is a special case of an multiline comment that stands in front of certain keywords.

Structure of a Doc Comment

/**
* Short description - used in indexlists
*
* Multiple line detailed description.
* The handling of line breaks and HTML is up to the renderer.
* Order: short description - detailed description - doc tags.
*
* @param	string	Target directory for the generated HTML Files
*/

... to be continued.

 
 
@copyright Ulf Wendel