Documentation options

Igor Stasenko siguctua at gmail.com
Wed Jan 2 18:18:05 UTC 2008


> I am not sure what "the right thing" is in this situation.
>
> Does this mean that the result is executable in place? Can it be copied
> and pasted to another workspace and
> still be executed as is?
>
> Adding features to browsers is a lost cause now that there are so many
> browsers to support with such features.
>
> I am not sure that I want all of my comments/documentation to be in
> green barely legible italics.
>
> The option of finishing method parsing at a line beginning with """"""
> is trivial to add to current systems in a safe way. I am using this for
> the 'Sake' documentation. Once we have an example of this in use it
> might be worth looking to put in place a more comprehensive solution.
>

I think, reserving a slot in CompiledMethod and in Class(es) for
documentation is better way.
Simply put there any object , which should answer #show message. And
then you can attach anything you like: URL, in-image PDF or
whatever...
> cheers
>
> Keith
>
>


-- 
Best regards,
Igor Stasenko AKA sig.



More information about the Squeak-dev mailing list