Re: Re: Need feedback about PEAR Coding Standard relatedto PHP_CodeSnifferusage

Gregory Beaver a écrit :

Chuck Burgess wrote:

On Dec 17, 2007 9:04 AM, Philippe Jausions <Philippe.Jausions@11abacus.com> wrote:

Hi Laurent, I'd agree with Greg that @ignore should only be used to not have documentation included for the **end user**. I believe it is best to have **all** code in PEAR to be properly documented with inline phpDoc, and not use @ignore as an excuse for sloppy coding practice. -Philippe

I agree with Greg and Philippe... I had been holding off on replying already, since you'd asked for QA and PEAR Group opinions first :)

@ignore's only intended purpose is to prevent a warning on documenting duplicate elements i.e.: if (blah) { class A {} } else { /** @ignore */ class A {} } Greg

Well in such example, and if we follow phpcs, we should code twice the same phpdoc class comment. if (blah) {

        /**
         * @param int $p1
         * @param int $p2
         */

class A ($p1, $p2) {} } else { /**

         * @param int $p1
         * @param int $p2
         * @ignore
         */

class A ($p1, $p2) {} } This is why I've ask the possibility not to avoid a properly documented code (it's not my point of view), but to avoid such situation. Dupplicate class comment seems useless here ! Laurent