[PEPr] Comment on Configuration::Config_Lite
| From: | Matthew Fonda | Date: | Thu, 06 Jan 2011 19:35:47 +0000 |
| Subject: | [PEPr] Comment on Configuration::Config_Lite | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-53950@lists.php.net to get a copy of this message | ||
I'd like to emphasize that docblock comments could be a little more
descriptive, as Christian pointed out. While the code and method names may
be self-explanatory, these comments are used to automatically generate API
documentation, so it's important that they give a lot of additional
details, beyond just the repeating the method name.
--
http://pear.php.net/pepr/pepr-proposal-show.php?id=645