Web site hosting and cheap domain name registration services
  

 Home

PEAR Manual
PrevChapter 4. Coding StandardsNext

Comments

Inline documentation for classes should follow the PHPDoc convention, similar to Javadoc. More information about PHPDoc can be found here: http://www.phpdoc.org/

Non-documentation comments are strongly encouraged. A general rule of thumb is that if you look at a section of code and think "Wow, I don't want to try and describe that", you need to comment it before you forget how it works.

C style comments (/* */) and standard C++ comments (//) are both fine. Use of Perl/shell style comments (#) is discouraged.


PrevHomeNext
Function DefinitionsUpIncluding Code

 

  

 

© 2002-2004 Active-Venture.com Website Hosting Service

 

Disclaimer: This documentation is provided only for the benefits of our web hosting customers.
For authoritative source of the documentation, please refer to http://pear.php.net/manual/

Recommended Resources: 

Cheap domain registrar : domain name registration and domain transfer services Cheap domain registration or register domain name from $5.95