[Newbies] Smalltalk klass dokumentation ?

[David Mitchell]

The hard part is writing the comments. Not the tools. We do have
tools, though...

The "like Javadoc" part is the class comments and method comments.

Click the ? between class and instance for the class you are interested in.

Unlike javadoc, there is no practice of inserting markup into
comments. There is capability of RichText, but I haven't seen anyone
use that since the 1990s. Plain text rules the day.

Like javadoc, people have built extraction tools. Few people use them
and the extracted comments rapidly fall out of date.

Like nearly all documentation, the comments rapidly fall out of date
in Smalltalk too.

You can write new comments and commit them. Search squeak-dev or the
wiki for documentation and you'll see lots of prior projects in this
space.



On Tue, May 11, 2010 at 5:46 AM, Kommentaren <kommentaren at bredband.net> wrote:
> Hi!
>
> I wonder if there is any documentation that documents the different classes
> and methods available in Smalltalk. Preferably like javadoc in java.
>
> For example, somewhere you could go when you want to understand a code like
> the following (taken from the Laser-game tutorial at squeak).
>
>
>
> panel := RectangleMorph new borderWidth: 0;
>
>    color: Color white;
>
>    layoutPolicy: ProportionalLayout new.
>
>
>
>
>
> panel
>
>    addMorph: self makeQuitGameButton
>
>    fullFrame:
>
>       (LayoutFrame
>
>          fractions: (0 at 1 corner: 1 at 1)
>
>          offsets: (
>
>             (20 @ (vertOffsetTop negated))
>
>         corner: (-20 @ (vertOffsetBtm negated)))).
>
>
>
>
> That is, you make a panel using the ProportionalLayout and then you add
> buttons to it. Here you need to know what the ProportionalLayout  is and how
> the fractions and offsets parameters work
> to understand how the buttons are placed.
>
>
>
>
>
> _______________________________________________
> Beginners mailing list
> Beginners at lists.squeakfoundation.org
> http://lists.squeakfoundation.org/mailman/listinfo/beginners
>
>