State of the Art for Clojure Documentation Tools -


In the past year, I have seen various announcements about the devices for document closure discussion and closure code at other places. . In this category, full literacy programming systems such as marginia, and tools are being used to make "closure in small pieces" (or eMACS org-mode), and more traditional Javadok-style solutions such as Otodock and Javadock themselves reportedly Can be used with the closure A Google search changes many other people, maybe there are some who are more noticeable, and make sure For that there are only individual utilities to create some docs. My question is, what are the best documented tools, and what are their comparative strengths and weaknesses based on their experiences? I have not used any document tools till date, and are interested in experimenting with one or more.

I really like if you want to take something like literate programming approach, marginia crosses your source code And creates an html formatted version with comments located next to the code in a very clear text. Comments can be formatted on the MarkBook, making a very readable final document. When I reviewed the source code some time ago, I know that marginia really helps. .

Note that this is different from the literate programming workflow, where you will write a file and generate the source code from it. With marginia, you write a regular source code file, and this documentation is removed from that production, what can be expected from literacy programming, but in this way you can not syntax in an editor without any special literacy programming help. Highlighting can be expected.

It interoperates with Leyeon, and I believe that cake, although I have not tried myself.

Comments