Re: Re: Need feedback about PEAR Coding Standard related to PHP_CodeSnifferusage
| From: | Gregory Beaver | Date: | Mon, 17 Dec 2007 22:39:30 +0000 |
| Subject: | Re: Re: Need feedback about PEAR Coding Standard related to PHP_CodeSnifferusage | ||
| References: | 1 2 3 | Groups: | php.pear.qa |
| Request: | Send a blank email to pear-qa+get-4703@lists.php.net to get a copy of this message | ||
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