[squeak-dev] [Documentation] Classes with class comment with size > 1000 chars

Hannes Hirzel hannes.hirzel at gmail.com
Sun May 2 19:50:36 UTC 2010


Regarding test cases, I agree. But I would put that as second priority.

If a Dictionary is a hash, yes, then there are no sorted keys.

But what is then the difference to the superclass #HashedCollection.


The comment of class dictionary:

I represent a set of elements that can be viewed from one of two
perspectives: a set of associations, or a container of values that are
externally named where the name can be any object that responds to =.
The external name is referred to as the key.  I inherit many
operations from Set.


When I'm looking for something like a TreeMap
http://java.sun.com/j2se/1.4.2/docs/api/java/util/TreeMap.html


So I would expect the following question answered.

In which sense is Dictionary specialising HashedCollection?

And a remark that the keys are not sorted by default.

--Hannes

--Hannes


On 5/2/10, Michael Haupt <mhaupt at gmail.com> wrote:
> Hi Hannes,
>
> On Sun, May 2, 2010 at 9:32 PM, Hannes Hirzel <hannes.hirzel at gmail.com>
> wrote:
>>> So, of 2033 classes in the image, 814 have no class comment *at all*.
>>> That's 40 %, and *that* is a shame.
>>
>> Or put it otherwise 60% have a comment. A good point to start .....  :-)
>
> I'm glad to see someone is accepting the optimist hat. :-)
>
>> The test classes are there to test the corresponding class. I think we
>> can safely say they do not need a comment at this time. How can we
>> exclude them from the metrics?
>
> I'd rather not do that - test classes may have certain characteristics
> in what they target, and how. It may be *very* interesting to know
> details about these things.
>
>>> A dictionary is not sorted by default. Or is it?
>>
>> So I wonder, where is the Collection with keys and values where the
>> keys are sorted?
>
> I'm afraid I don't understand - Dictionary uses hashing internally.
> There is no sorted collection of keys in there. In case you mean to
> ask whether there is any Collection that does this, I'm afraid there
> is none (but that's me talking).
>
> Best,
>
> Michael
>
>



More information about the Squeak-dev mailing list