[wp-hackers] Inline Documentation Effort was a Failure

[Jorge Peña]

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.

Couldn't a script be written that does that? Just wondering. And if we only
want to get rid of the inline documentation we could prefix or somehow match
for inline documentation so that we don't get rid of other comments which we
might want to keep.

Of course, this is even if you guys think this is a good idea. I myself
don't know, though I am all for documentation.

On Tue, May 27, 2008 at 12:37 PM, Otto <otto at ottodestruct.com> wrote:

> 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
> > http://lists.automattic.com/mailman/listinfo/wp-hackers
> >
> _______________________________________________
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-hackers
>