Class comments!?
goran.krampe at bluefish.se
goran.krampe at bluefish.se
Sun Oct 17 22:35:51 UTC 2004
Hi Yoshiki and everyone!
Yoshiki Ohshima <Yoshiki.Ohshima at acm.org> wrote:
> Göran,
>
> At Sun, 17 Oct 2004 23:02:47 +0200 ,
> goran.krampe at bluefish.se wrote:
> >
> > Hi Yoshiki and all!
> >
> > Yoshiki Ohshima <Yoshiki.Ohshima at acm.org> wrote:
> > > Göran,
> > >
> > > > I mean, sure, some of these can have short comments - but is it just me
> > > > getting ANNOYED when there is NO COMMENT AT ALL?!
> > >
> > > I am, too (regarding clas comments, but not method comments for most
> > > of the case). What should I do?
> >
> > First of all - let me reiterate that I am very, very impressed with your
> > work. I REALLY wasn't trying to criticize you in this, but I agree it
> > might have sounded like it. I deeply and honestly apologize for that.
> > Really.
>
> Thank you, and I'm really, really not offended at all.
Good. :)
> I am annoyed
> in the similar manner that I'm annoyed by the sorry state of my
> apartment room. I know the problem, but the days pass without any
> serious measure.
Hehe, yeah - I know what you mean. :) From that more personal
perspective I only have some small advice - it works pretty ok for me,
but that doesn't mean it works for anyone else:
1. When I create a class I actually *start* by writing the class
comment! It is mainly to clear my head and get my own intention straight
and formulated. Typically a paragraph or two.
2. Since the class comment I first wrote will most likely "rot" while I
continue to develop I have added an extra step when I release my code.
This extra step I sometimes forget - but hey... :) And that is to go
through all class comments and reread them to see if they have turned
rotten. Sure, for small releases when I haven't changed much I don't do
this - but at least for the bigger releases.
Of course - it helps now that the class comments are visible in the
browser. In red even, if it is missing! :)
> > You simply write a class comment for each new class that have been
> > introduced into the image.
>
> I'll do it when I can.
I know. And unfortunately I don't know of any medicine with a better
taste. :)
> Thank you, Göran. Somebody has to be that position.
Well, I don't know. This is the last time I am bringing this issue up
because I am frankly tired of discussing it - not due to any fault on
your side of course, but due to other people arguing against what I
consider to be a very obvious simple rule (that each class in the base
image has a class comment, no matter how short).
Perhaps we just have to face the fact that we Squeakers simply aren't
capable of doing any better. :)
> -- Yoshiki
regards, Göran
PS. Keep up the brilliant work. :)
More information about the Squeak-dev
mailing list
|