Re: method synopsis formatting
| From: | Horst Schirmeier | Date: | Sat, 08 Jan 2005 13:02:09 +0000 |
| Subject: | Re: method synopsis formatting | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969365869@lists.php.net to get a copy of this message | ||
On Sat, 08 Jan 2005, Gabor Hojtsy wrote:
> >mixed array_search ( mixed needle, array haystack [, bool strict])
> >
> >to some PEAR coding standards conform:
> >
> >(1)
> >mixed array_search(mixed needle, array haystack [, bool strict])
> >
> >or a maybe better readable:
> >
> >(2)
> >mixed array_search (mixed needle, array haystack [, bool strict])
>
> Since the type names and the optional [] signs are not used in the PHP
> syntax anyway, I don't think that this is really something to make in
> line with the PEAR coding standards.
Okay, agreed.
> AFAIS it is more readable to have
> some spaces between the function name and the first param's type name.
Then I'd at least suggest adding a space before the closing parenthesis
(and lining up the DSSSL with the XSL which already implements that):
(3)
mixed array_search ( mixed needle, array haystack [, bool strict] )
Objections
Regards,
Horst Schirmeier
--
PGP-Key 0xD40E0E7A