[PEAR-BUG] Bug #20477 [Opn->Csd]: PHPCS & PHPDoc difference on @package tag?
[email protected] Mon, 5 Jan 2015 03:07:16 +0000 (GMT)
| Newsgroups | php.pear.bugs |
|---|---|
| Message-ID | <[email protected]> |
Edit report at https://pear.php.net/bugs/bug.php?id=20477&edit=1 ID: 20477 Updated by: [email protected] Reported By: jc at tpages dot com Summary: PHPCS & PHPDoc difference on @package tag? -Status: Open +Status: Closed Type: Bug Package: PHP_CodeSniffer Operating System: CentOS 6 Package Version: 2.1.0 PHP Version: 5.4.36 -Assigned To: +Assigned To: squiz Roadmap Versions: New Comment: -Status: Open +Status: Closed -Assigned To: +Assigned To: squiz PHPCS is just implementing the PEAR coding standard. See the example file here: http://pear.php.net/manual/en/standards.sample.php I didn't write this standard, but I assume phpdoc allowed this syntax in the past given that all PEAR docs have been written like this. So maybe it is a PHPDoc regression, or a new standard. Maybe use a different coding standard if you don't like the way the PEAR one works. PSR2 is a good one to try as it doesn't enforce any documentation standards. Previous Comments: ------------------------------------------------------------------------ [2014-12-30 08:21:15] eidng8 Opened an issue on Github too, links here for convenience: https://github.com/phpDocumentor/phpDocumentor2/issues/1508 ------------------------------------------------------------------------ [2014-12-30 08:11:46] eidng8 Description: ------------ I'm using PHP_CodeSniffer and PHPDoc, and got an frustrating issue: phpcs requires the package tag to present in every file and class doc block. While phpdoc allows only one package tag per file. Which one to follow? ------------------------------------------------------------------------ -- Edit this bug report at https://pear.php.net/bugs/bug.php?id=20477&edit=1