[Seaside] Re: too many comments

Jason Johnson jbjohns at libsource.com
Sun Apr 15 08:33:13 UTC 2007

+1.  And one I like is explaining *why* certain decisions were made.

In the outside world, if there is some condition that is dangerous that 
causes people to get hurt, someone generally puts up a sign so that 
people don't get hurt over and over.  Likewise in code, if there is 
something someone tried that was a lot of work which had a big 
non-obvious problem down the road, throw up a sign.  If we get to the 
point where we trust version information to stay around forever (or 
maybe we do already), this might be a good place for that kind of 
information (and in the method at least a "#see version 3 for 
explanation" type reference).

tim Rowledge wrote:
> Code says what the method does.
> Comments (should) say what the method is*meant* to do
> It is almost never the case that the two are congruent.
> tim
> -- 
> tim Rowledge; tim at rowledge.org; http://www.rowledge.org/tim
> Make sure your code "does nothing" gracefully.
> _______________________________________________
> Seaside mailing list
> Seaside at lists.squeakfoundation.org
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside

More information about the Seaside mailing list