[wp-hackers] Inline documentation

[Vogel, Andrew (vogelap)]

How much overhead does inline comments add to the code? I cannot imagine
it to be very much. I agree with Scott that the teaching aspects are
important.

-andrew vogel
Manager of Professional Programs
University of Cincinnati
College of Pharmacy 
 

> -----Original Message-----
> From: wp-hackers-bounces at lists.automattic.com 
> [mailto:wp-hackers-bounces at lists.automattic.com] On Behalf Of 
> Scott Merrill
> Sent: Wednesday, February 15, 2006 2:26 PM
> To: wp-hackers at lists.automattic.com
> Subject: Re: [wp-hackers] Inline documentation
> 
> Roy Schestowitz wrote:
> > 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.
> 
> I _strongly_ disagree with this approach.  A lot of people 
> have learned PHP by fiddling with WordPress.  I've personally 
> encouraged a handful of people to do so.  I think WordPress 
> should be making an effort to _encourage_ people to work 
> through the code whenever they have an interest in doing so.  
> Comments are a good way to help a new developer learn the internals.
> 
> Requiring them to fetch the "development source" seems like a 
> gigantic waste of time, and a real disservice.
> 
> --
> skippy at skippy.net | http://skippy.net/
> 
> gpg --keyserver pgp.mit.edu --recv-keys 9CFA4B35 506C F8BB 
> 17AE 8A05 0B49  3544 476A 7DEC 9CFA 4B35 
> _______________________________________________
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-hackers
>