Re: Request for PHP_CodeSniffer : support DockBlock TemplatesofphpDocumentor

From: Date: Sun, 11 Nov 2007 22:38:50 +0000
Subject: Re: Request for PHP_CodeSniffer : support DockBlock TemplatesofphpDocumentor
References: 1 2 3 4 5 6  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-48446@lists.php.net to get a copy of this message
Greg Sherwood wrote: > Christian Weiske wrote: >> Greg, >> >>> 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? >>> >> My +1 was more a "phpcs doesn't need to implement it" >> > I do need to do something though. Even if I remove the error and allow > docblocks to *begin* with /** rather than exactly match /**, you'll get > errors for all the tags you have omitted because of your templates. > > There are a lot of rules defined in the current PEAR docblock standards > that will need changing in phpcs for this: > http://pear.php.net/manual/en/standards.sample.php For easing your pain, I recommend simply skipping docblock templates with a warning that it was found and skipped. Greg

« previous php.pear.dev (#48446) next »