Re: CodeSniffer throw warning for missing filedoc

Hello Harley, > 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. It is only redundant if you have no other code except the class - that is, no require/include calls, no global functions, no global constants etc. -- Regards/Mit freundlichen Grüßen Christian Weiske -= Geeking around in the name of science since 1982 =-

Attachment: [application/pgp-signature] signature.asc