Re: Request for PHP_CodeSniffer : support DockBlock Templates of phpDocumentor
| From: | Greg Sherwood | Date: | Sun, 11 Nov 2007 21:27:40 +0000 |
| Subject: | Re: Request for PHP_CodeSniffer : support DockBlock Templates of phpDocumentor | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-48438@lists.php.net to get a copy of this message | ||
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.
Greg
Laurent Laville wrote:
Hi Greg, While I was running PHP_CodeSniffer on File.php of PEAR_PackageFileManager, I found that phpcs 1.0.0RC1 does not yet support DockBlock Templates of phpDocumentor I got following output ERROR | You must use "/**" style comments for a function comment Is it possible for you to include support of such coding before final stable version 1.0.0 Laurent [1] http://manual.phpdoc.org/HTMLframesConverter/phpdoc.de/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.docblocktemplate