coding standards sample page
| From: | Daniel Convissor | Date: | Sat, 05 Jun 2004 19:15:55 +0000 |
| Subject: | coding standards sample page | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-29999@lists.php.net to get a copy of this message | ||
Hi Folks:
You may have seen the commits I made a few weeks ago to peardoc. It added
a complete sample file to the coding standards section of the manual.
One thing people may notice is it goes into major detail over how to write
docblocks. Some people may think it goes overboard. I provided that
information because it seemed very important to improving PEAR's usability
and quality (if only the perception thereof), particularly now that the
API documentation is automatically available via the website.
The DocBlock instructions are primarily from the "Javadoc Style Guide" and
slightly modified to deal with differences in PHP and phpDocumentor.
It seems the majority of existing files in the repository (including,
*COUGH*, those by proposed QA team members, *COUGH*) don't follow the
JavaDoc/phpDocumentor styles. Similarly, there are things I need to clean
up in the DB docblocks as well -- at least I'm in good company.
Anyway, here's the manual page:
http://pear.php.net/manual/en/standards.sample.php
Please let me know if you have any feedback. I'll be happy to incorporate
changes.
Thanks,
--Dan
--
T H E A N A L Y S I S A N D S O L U T I O N S C O M P A N Y
data intensive web and database programming
http://www.AnalysisAndSolutions.com/
4015 7th Ave #4, Brooklyn NY 11232 v: 718-854-0335 f: 718-854-0409