Re: Request for PHP_CodeSniffer : support DockBlock TemplatesofphpDocumentor

Gregory Beaver wrote:

Greg Sherwood wrote:

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. I can certainly do that, as long as it is okay that this code:

class MyClass { /**#@+

    * Sorting functions for the file list
    * @param string
    * @param string
    * @access private
    */

function sortfiles($a, $b) {

       // code here

} function mystrucsort($a, $b) {

       // code here

} /**#@-*/ } Will not report an error about mystructsort not containing any comment about what it does (or is used for) specifically, and none of the standard docblock errors like no @return or missing parameter names. Does this sound fine? Greg