[squeak-dev] Re: Documentation idea
Pascal Vollmer
pascal.vollmer at nexgo.de
Tue Jul 5 21:58:18 UTC 2011
Bert Freudenberg <bert <at> freudenbergs.de> writes:
>
> Why not use structured class comments? Seems cleaner to me than littering the
system with documentation
> methods. E.g.
>
> !LayoutMorph commentStamp: 'bf 7/5/2011 17:24' prior: 0!
> Collaborators: SystemWindow, MorphExtension, LayoutMorph
> Responsibilities: Lay out my submorphs in a row or column
> !
>
I agree with Bert. Suggestions for the format to use in the class comment:
ASCIIDOC, Markdown, DocBook. DocBook for instance paves the way for HTML and PDF.
More information about the Squeak-dev
mailing list
|