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

From: Date: Wed, 12 Nov 2008 22:19:57 +0000
Subject: [PEPr] Comment on RFC::Amendment of Docblock Comment Standards
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-51074@lists.php.net to get a copy of this message
Jorrit Schippers (http://pear.php.net/user/jorrit) has commented on the proposal for RFC::Amendment of Docblock Comment Standards. Comment: 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. I fear that with this proposal accepted, different styles of commenting start to appear within one file, and as a result it will look more and more sloppy. 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. I understand that I should have brought this vision in the PEAR-DEV list discussion preceding this PEPr, but I forgot to do this. I think the param name in @param should be kept. This is far more common practice in PHPDoc than without, and is as such more compatible with editors like Eclipse/PDT. Proposal information: http://pear.php.net/pepr/pepr-proposal-show.php?id=580 -- Sent by PEPr, the automatic proposal system at http://pear.php.net

« previous php.pear.dev (#51074) next »