[wp-hackers] Inline Documentation Effort was a Failure
jason at intraffic.net
Wed May 28 02:17:32 GMT 2008
I completely concur with Otto.
Not to mention, an extra, maybe 300kb in the distributable for inline
documentation? I can't possibly image anyone getting their panties in a
knot because the package went from 1.2Mb to 1.5Mb.
the end-user on page loads.
Simply put, it just doesn't affect performance at all, but dramatically
increases code maintainability. Which is especially important in an open
source project, where who knows is going to have to deal with your code
at a later date.
> PHP's ability to ignore comments is *extremely* fast, and it's highly
> unlikely that you'd notice any performance difference whatsoever.
> You'd get a *lot* more speed benefits out of a PHP opcode cache on the
> server than you ever would with comment removal.
> On Tue, May 27, 2008 at 8:44 AM, Callum Macdonald
> <lists.automattic.com at callum-macdonald.com> wrote:
>> spencerp wrote:
>>> I agree with everything you said. Just curious, doesn't all this
>>> documentation to each PHP file, only had more bulk/ size per file too? So,
>>> instead of having a normal 2kb sized file, after documentation was added, it
>>> might be 3 or 4kb?
>> I think this is a valid point. I'm *all* in favour of documentation,
>> particularly in-line. I think it's an excellent thing.
>> Presumably it wouldn't be that hard to strip it out for the "released"
>> version of WordPress? So if you want the documentation, grab the code from
>> svn. If not, grab the ZIP and get a nice light download.
>> This would require support from the core devs, packagers, etc.
>> Cheers - Callum.
>> wp-hackers mailing list
>> wp-hackers at lists.automattic.com
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
More information about the wp-hackers