CodeSniffer throw warning for missing filedoc
| From: | Harley Bussell | Date: | Mon, 08 Dec 2008 03:38:08 +0000 |
| Subject: | CodeSniffer throw warning for missing filedoc | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-51223@lists.php.net to get a copy of this message | ||
How would you feel about making the CodeSniffer throw warnings instead
of errors for missing filedoc comments?
Having both class comment and filedoc comments can be redundant when
the file only contains 1 class, and nothing outside the class.
Filedoc comments work well if the file contains multiple classes or global code.
From my own experience the filedoc is little more than a copy of the
class comment, with inline license text and the first line from the
class comment or the class name. It does not really add anything of
value.
Thanks