| 05 - Comments |
| Mambo Coding Standards | |
| Mar 03, 2007 at 10:39 AM | |
|
Complete inline documentation comment blocks (docblocks) must be provided. Inline documentation for classes should follow the phpDocumentor convention. More information about phpDocumentor can be found here: http://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. |
|
| <Previous | Next> |
|---|
