[plt-scheme] documentation guidelines & tools

From: Robby Findler (robby at cs.uchicago.edu)
Date: Fri Jun 8 11:25:47 EDT 2007

Is the emacs integration all about helping people build
Schemedoc-style comments, or is there navigation and other things in
there too?

Thanks,
Robby

On 6/8/07, Matthias Felleisen <matthias at ccs.neu.edu> wrote:
> I wonder whether someone could turn this into a button-based tool à
> la Check Syntax for all 'professional' language levels. -- Matthias
>
>
>
>
> On Jun 8, 2007, at 11:15 AM, Grant Rettke wrote:
>
> > Schemedoc works for code that does not live in modules and runs on
> > v370:
> >
> > http://www.cs.aau.dk/~normark/schemedoc/
> >
> > On 6/7/07, YC <yinso.chen at gmail.com> wrote:
> >> Hi all -
> >>
> >> I have a few questions regarding creating documentations for
> >> libraries...
> >> thanks for any input ;)
> >>
> >> 1) Is there a standard guideline on how to do documentations/
> >> comments?
> >>
> >> 2) Most libs have doc.txt - is there a standard template for
> >> doc.txt and
> >> explanations for its format?
> >>
> >> 3) Any Scheme philosophy on inline documentations in the code
> >> (i.e. for or
> >> against) - It seems that Scheme doesn't have docstrings, does this
> >> mean it's
> >> not actively encouraged as a style?
> >>
> >> 4) Any tools for generating doc.txt from inline documentations?
> >>
> >> Thanks,
> >> yinso
> >>
> >>
> >> _________________________________________________
> >>   For list-related administrative tasks:
> >>   http://list.cs.brown.edu/mailman/listinfo/plt-scheme
> >>
> >>
> > _________________________________________________
> >  For list-related administrative tasks:
> >  http://list.cs.brown.edu/mailman/listinfo/plt-scheme
>
> _________________________________________________
>   For list-related administrative tasks:
>   http://list.cs.brown.edu/mailman/listinfo/plt-scheme
>

Posted on the users mailing list.