[Seaside] Re: too many comments
stephan at stack.nl
Sat Apr 14 15:49:00 UTC 2007
On Sat, Apr 14, 2007 at 06:17:14AM +0200, seaside-request at lists.squeakfoundation.org wrote:
> Well, I'll gladly have *that* problem :-) And I'll happily trade a few
> hundred overly lengthy comments against the 250+ uncommented classes and
> 2500+ uncommented methods in Seaside ;-)
I wouldn't. Sifting through garbage is much less fun than reading
good code. With a good design document and tutorials, I only want to see
comments on special cases/optimisations. .
> Oh, wow. Have you truly ever been in a situation where you've really
> felt that reading the comments wasn't worth it? Not on a small scale
> (I'm sure there are a few methods for which the comments are inadequate)
> but on a scale of a framework like Seaside. A situation where you'd
> rather been without any comments to begin with? I find it hard to even
> imagine what code must look like which has been "commented to death" (if
> you have an example I'd really love to check it out). Usually, that's
> not exactly the kind of problem I face ;-)
JHotDraw in a pre-sourceforge version has the javadoc style of comments.
They absolutely add nothing to the understanding of the code, while
allowing one to see half the number of relevant lines of code.
And then there's all sample code published by Apple. Every file
starts with a page full of disclaimer/copyright comments.
More information about the Seaside