On Sun, 17 Oct 2004 00:37:25 -0700, Blake <blake at kingdomrpg.com> wrote:

> But we've gotten away from what I perceived the initial argument about  
> comments to be: Some people champion commenting EACH LINE of code. What  
> I've been trying to communicate is that that's not usually necessary, and  
> it's often a bad idea. Maybe you disagree, but so far, I've seen defense  
> of "macro"-comments, which I'm pro.

I agree with you completely on this -- probably 95% of "code" (i.e., lines
& expressions inside methods) doesn't require a comment. Occasionally, I
add comments inside a method if I'm making an assumption about something
that isn't directly reflected in the code, for whatever reason.

I'd love to see inherited method comments like you describe. At Interval
Research, one of the things we were talking about was using the (internal
to Smalltalk) web browser to make comments more "active", so they could
have embedded hyperlinks and such. It wouldn't be hard to expand something
like that to do what you're proposing.

Later,
Jon

--------------------------------------------------------------
   Jon Hylands      Jon at huv.com      http://www.huv.com/jon

  Project: Micro Seeker (Micro Autonomous Underwater Vehicle)
           http://www.huv.com