[plt-scheme] documentation guidelines & tools

From: YC (yinso.chen at gmail.com)
Date: Thu Jun 7 22:31:11 EDT 2007

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?

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.racket-lang.org/users/archive/attachments/20070607/caac99ad/attachment.html>

Posted on the users mailing list.