Re: Request for PHP_CodeSniffer : support DockBlock TemplatesofphpDocumentor
| From: | Gregory Beaver | Date: | Sun, 11 Nov 2007 22:19:02 +0000 |
| Subject: | Re: Request for PHP_CodeSniffer : support DockBlock TemplatesofphpDocumentor | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-48442@lists.php.net to get a copy of this message | ||
Gregory Beaver wrote:
> Greg Sherwood wrote:
>> Hi,
>>
>> I've never seen those docblock templates, but wow! I think PEAR as a
>> whole should decide it they should be allowed or not before making any
>> changes.
>>
>> IMO, they make the code much harder to read as you now have to search up
>> the page to find the tags. This is fine for a script parsing the
>> functions, but is it also fine for some poor developer who is reading
>> the code? Maybe it's just me.
>
> Huge -1 from me. We have enough anal retentive restrictive rules in PEAR.
Allow me to clarify further: The point of regulations are to remedy
problems as they occur, or to nail existing problems.
Docblock templates have been around for almost 4 years, and it has not
caused any problems in PEAR of overuse. This isn't a potential new
problem of millions of developers suddenly adopting docblock templates
in their code.
Banning them would be the equivalent of outlawing the consumption of
windshield wiper fluid. Sure, it's probably not the best thing to do
for your personal health in most situations, but is there really an
epidemic that needs addressing?
Greg