From: Chad Perrin <perrin@...>
Date: 2007-07-02T02:36:18+09:00
Subject: Re: newby non/programmer trying to understand classes

On Mon, Jul 02, 2007 at 02:25:22AM +0900, John Joyce wrote:
> 
> Don't document your code for other people,  do it for yourself!!
> You WILL FORGET what something does!

When you come back to your code later, *you* are a different person.


> Especially, when you're new at it.
> So don't be afraid to over document in the beginning.
> It takes time to develop a documentation style that is concise but  
> still clear.
> Eventually, you will document less because Ruby is very readable, but  
> always say what a variable or object is supposed to do, what it  
> recieves, what it returns, and maybe even why.

I take it you don't subscribe to the notion that code should tell us
"how" and comments should tell us "why", then.

-- 
CCD CopyWrite Chad Perrin [ http://ccd.apotheon.org ]
awj @reddit: "The terms never and always are never always true."