[PEPr] Comment on RFC::Coding standard enhancements
| From: | Daniel O'Connor | Date: | Mon, 03 Nov 2008 07:17:49 +0000 |
| Subject: | [PEPr] Comment on RFC::Coding standard enhancements | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-50997@lists.php.net to get a copy of this message | ||
Daniel O'Connor (http://pear.php.net/user/doconnor) has commented on the proposal for
RFC::Coding standard enhancements.
Comment:
From staring at PHPCS results for a long long time; the biggest areas where
people fall down:
1) "@param string $param Oops, did you just put more than one space
param or your variable"
Kind of pointless; most documentation generators can deal with it.
2) Forgetting to put in /** @return null */ or void when a method doesn't
actually return things
3) File comments & Class comments having to duplicate a lot of the
required tags; and get the indentation right.
IE:
/**
* File.php
*
* ... snip ...
*
* @category Fishing
* @author Dave <dave@dave.com>
*/
... snip ..
/**
* File_Class
*
* ... snip ...
*
* @category Fishing
* @author Dave <dave@dave.com>
*/
... will yell at you for incorrectly doing to docblocks.
Proposal information:
http://pear.php.net/pepr/pepr-proposal-show.php?id=538
--
Sent by PEPr, the automatic proposal system at http://pear.php.net