Re: [PEPr] Comment on RFC::Coding standard enhancements

On Mon, Nov 3, 2008 at 1:17 AM, Daniel O'Connor <daniel.oconnor@gmail.com> wrote: > > 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. I agree with this one - PEAR (usually) requires one class per file, so the file & class docblocks are nearly identical - in Pyrus this becomes REALLY evident because there are no require statements in between the two. I wonder though - is this more of a phpdocumentor limitation, than a PEAR CS limitation? -- Brett Bieber