[squeak-dev] Re: Documentation idea

Frank Shearar frank.shearar at gmail.com
Wed Jul 6 07:26:10 UTC 2011


On 5 July 2011 22:58, Pascal Vollmer <pascal.vollmer at nexgo.de> wrote:
> 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.

Markdown seems to be gaining traction: lots of GitHub projects use it,
the StackExchange sites use it, ...

frank



More information about the Squeak-dev mailing list