[wp-hackers] Inline documentation

Roy Schestowitz r at schestowitz.com
Wed Feb 15 19:19:53 GMT 2006

_____/ On Wed 15 Feb 2006 18:33:15 GMT, [Doug Stewart] wrote : \_____

> Craig wrote:
>> As someone who wants to learn PHP via dissecting WordPress, I'd love to see
>> this. I think it would be worth the extra cost of file weight. Besides,
>> "bloat" is really about functionality that is better attached via plugin or
>> other means, and should never be used in conjunction with adding value to
>> code by making it easier to understand and therefore use, change, or
>> improve.
> Hey, I've got an idea - ship two .zips, a .dev edition with full 
> comments and a .standard edition with no whitespace whatsoever.
> Sorry.  I'll go back to lurking.

Comment ought to be accumulated and always remain in tact in the repository.
Each time release milestone is reached, run a parser which strips all
comments and publish.

Developers can fetch documented code of interest from the SVN repository,
the nightly, or a Developer Edition. It is worth using the same tactic with
debugging bits in the code. If there are none, something in development
model is probably missed.


More information about the wp-hackers mailing list