[PEPr] Comment on PEAR::NameScheme
| From: | PEPr | Date: | Sun, 06 Jun 2004 13:35:47 +0000 |
| Subject: | [PEPr] Comment on PEAR::NameScheme | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-30030@lists.php.net to get a copy of this message | ||
David Costa (http://pear.php.net/user/gurugeek) has commented on the proposal for PEAR::NameScheme.
Comment:
You do need to comment at least each function for the docbook. This is not optional but a written
standard see
http://pear.php.net/manual/en/standards.comments.php
all your function declarations are wrong see
http://pear.php.net/manual/en/standards.funcdef.php
also with no comments at all this is a -1 for me, as per my email:
"I personally think that there is no such a thing that "code clear enough without any
comment".
Even if I do
print_r ($this->Object);
I would comment like // debugging the object X "
Please check carefully the sample file http://pear.php.net/manual/en/standards.sample.php
and the Manual section on standards.
Thanks
David Costa
Proposal information:
http://pear.php.net/pepr/pepr-proposal-show.php?id=82
--
Sent by PEPr, the automatic proposal system at http://pear.php.net