[PEPr] Comment on RFC::Amendment of Docblock Comment Standards
| From: | Till Klampaeckel | Date: | Wed, 12 Nov 2008 21:35:24 +0000 |
| Subject: | [PEPr] Comment on RFC::Amendment of Docblock Comment Standards | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-51069@lists.php.net to get a copy of this message | ||
Till Klampaeckel (http://pear.php.net/user/till) has commented on the proposal for RFC::Amendment of
Docblock Comment Standards.
Comment:
I'm fine with all your spacing issues, even though I can't really relate to
them being such a problem. However I'm for keeping @return and also the
parameter name in @param.
It's just easier to read and connect when I look at code which I haven't
written myself.
Also, I feel like one important issue is almost always overseen when
people voice their opinion on the coding standards and how obnoxious it is
to follow them.
We should keep in mind that one is most likely to not write documentation
for yourself - but for other people who use the code.
I found that our CS while maybe hard to get used to, is really helpful
when it comes to looking at someone else' code. It's just easy to get into
it. And it's even easier for myself to get back into my own code which I
haven't looked at in six months.
Proposal information:
http://pear.php.net/pepr/pepr-proposal-show.php?id=580
--
Sent by PEPr, the automatic proposal system at http://pear.php.net