Re: [PEPr] Comment on RFC::Amendment of Docblock Comment Standards

Hi, Jorrit Schippers wrote:

I think the original issue was that comment related CS were littering the output of phpcs with errors such that the code related CS issues became hard to spot. I think this proposal is a bad solution to this problem. PHP_CodeSniffer could be adapted such that one can distinguish between these two classes of problems.

The problem is, there can be genuine phpdoc errors in the output, like missing a @param tag for a parameter. Your proposal won't quite help here, they'll be as hard to spot as they are now.

If one understands the comment style guide before one starts coding, there is no extra effort needed to remain CS compliant. I suggest the CS guide to be made more explicit instead of less explicit, such that the CS is properly documented instead of implicitly documented in one example.

Agree here, the current standard-by-example is extremely hard to read and understand, I noted that in the RFC.