[<<][staapl][>>][..]
Tue May 13 12:56:32 CEST 2008

documentation

Time to start documenting. Let's make it a literal program with proper
online cross-ref + a way to reference to ramblings. Let's make this
into a tool to structure code for refactoring purposes.

Starting with scat.ss


2 kinds of comments:
   * paragraph:              ;; blabla
   * column                  (+ 1 2) ;; add it

comments are attached to an expression.

maybe it's best to avoid column comments entirely?


http://groups.google.com/group/plt-scheme/browse_thread/thread/1e2cae24ec84b70a/b59b55e3990da368?lnk=gst&q=scribble#b59b55e3990da368

That thread has an interesting comment on source code documentation:
you need BOTH reference (per function doc) and general overview /
meaning of a bunch of functions.



[Reply][About]
[<<][staapl][>>][..]