[Squeakfoundation]re: TrueType font support and 3.6

goran.krampe at bluefish.se goran.krampe at bluefish.se
Mon Jun 23 11:17:14 CEST 2003


Hi Andreas!

"Andreas Raab" <andreas.raab at gmx.de> wrote:
> Hi Göran,
> 
> I am just trying to figure out what exactly your review rules are. You

Good luck! :-) There aren't any exact review rules yet. At least AFAIK.

> mention some concrete things which weren't on Daniel's list - perhaps it's
> time to write them down? You mention #isKindOf: and comments. What's the

Write them down? If you mean as "rules that we have agreed upon" - then
yes, we should try to formulate those (at least a lowest level ruleset).
My inbox is overflowing but I think Daniel, Doug and more have been
discussing this issue.

If you mean for TTF then I did write them down and sent it to Yoshiki.

> policy for those?

If you are asking me *personally* then I would say:

- Use of isKindOf: and similar "type testing" messages can of course be
warranted. But when I see such code I always get "healthily suspicious".
:-) Yoshiki used it in order to not need to change existing code - which
is of course fine if you want to be an "addon package" for the rest of
your life. But now we wanted to integrate TTF and then he agreed with me
that the proper changes ought to be made (don't ask, I don't recall).
Otherwise code will start to rot.

- Comments. My *very easily achievable* standards are:

1. A class comment for each class. Trivial classes should ideally also
have one just so that people don't have to wonder "Hmmm, did the author
forget to write a comment or is this class actually trivial?". But I
don't care if the comment is long or short or formatted in the shape of
a banana. I don't want it to simply list the instvars etc. I want to
know what the darn thing is and the most important things the author
thinks he has time to tell me about.

2. Method comments. Unless we are talking about "trivial" methods like
accessing methods or obvious methods in some other way - I *want* method
comments. Just tell me what the hell the method does!

I mean, we *are* talking about base classes that people will try to
understand, not some fun addon game package on SM.
 
> Cheers,
>   - Andreas

regards, Göran


More information about the Squeakfoundation mailing list