RE: [PHP] Comments in code
| From: | Jay Blanchard | Date: | Wed, 11 Sep 2002 13:01:02 +0000 |
| Subject: | RE: [PHP] Comments in code | ||
| References: | 1 | Groups: | php.general |
| Request: | Send a blank email to php-general+get-115971@lists.php.net to get a copy of this message | ||
[snip]
I just started writing comments in my code for use with phpdocumentor.
And Im beginning to wonder if too many comments is a *bad* thing.
I was wondering about file size, but dont think that can be avoided, and
php's parser speed.
Nothing bad, just looking to see what others have to say about it.
Thanks
[/snip]
Zen & The Art of Commenting Code
1. Comment only that which does not make obvious sense, and comment well on
that. Explain as clearly, but succinctly as possible. If 2 words suffice,
do not use 14.
2. Comments are only part of the documentation.
:^]
Jay