Re: One more thing ...

On Sat, Apr 5, 2008 at 7:35 AM, Helgi Þormar Þorbjörnsson <helgith@gmail.com> wrote: > Okey that's what I was talking about, 148 should not be an error, not > even close > > And I'm not sure what the heck 195 is about ... Who cares if there is a > line break or not ? (I rather like having a line break actually) and for the > last error I'm a bit stumped > > Lets hope Greg can fix those or at least turn them into warnings .......... > > - Helgi > > On Sat, Apr 5, 2008 at 5:25 AM, Joe Stump <joe@joestump.net> wrote: > > > FILE: /Users/jstump/dev/foo.php > > > > > -------------------------------------------------------------------------------- > > FOUND 3 ERROR(S) AND 1 WARNING(S) AFFECTING 3 LINE(S) > > > > > -------------------------------------------------------------------------------- > > 72 | WARNING | Line exceeds 85 characters; contains 105 characters > > 148 | ERROR | There must be exactly one blank line before the tags in > > | | function comment > > 195 | ERROR | Parameters must appear immediately after the comment > > 195 | ERROR | Expected 1 space after the longest variable name > > > > > -------------------------------------------------------------------------------- > > > > That was against this file: > > http://pear.php.net/manual/en/standards.sample.php > > > > --Joe > I believe the purposes of whoever wrote the examples in the manual (which is what Greg uses as his "gold standard" of what the PEAR CS rules are), you highlight your params tags more than any others by listing them before all others, and you segregate them from the others by a leading empty line and a trailing empty line. So, that I believe is why the documented example of a proper PEAR CS'd docblock looks that way... and I'm sure Greg's reasoning for enforcing it is solely because the example looks that way. -- CRB