marginalia

State of the Art for Clojure Documentation Tools [closed]

by

I really like Marginalia if you want to take something like a literate programming approach. Marginalia traverses your source code, and produces an html formatted version with comments set beside code in a very clear text. Comments can be markdown formatted, making for a very readable final document. When reviewing source code that I’ve written … Read more

What is the difference between ; and ;; in Clojure code comments?

by

There is no difference as far as the interpreter is concerned. Think of ; ;; ;;; and ;;;; as different heading levels. Here is my personal use convention: ;;;; Top-of-file level comments, such as a description of the whole file/module/namespace ;;; Documentation for major code sections (i.e. groups of functions) within the file. ;; Documentation … Read more

tech