Clojure文档工具的最新技术状态
在过去一年左右，我在Clojure讨论清单和其他有关记录Clojure代码的工具的地方看到了各种公告。 这些范围包括像Marginalia这样全面的文字编程系统，以及用于创建“Clojure in Small Pieces”（甚至emacs org模式）一书的工具，以及更传统的Javadoc风格解决方案，如Autodoc和Javadoc本身。据说可以和Clojure一起使用。 谷歌搜索变成了其他各种各样的，也许是值得更多关注的一些，并且肯定有些只是用于生成文档的个人实用程序。 我的问题是什么是最好的文档工具，根据你使用它们的经验，他们的比较优势和劣势是什么？ 迄今为止我还没有使用任何文档工具，并且有兴趣尝试一个或多个。
我非常喜欢Marginalia，如果你想采取一种文学编程方法。 Marginalia遍历你的源代码，并生成一个HTML格式的版本，其代码旁边的注释以非常明确的文本形式出现。 评论可以用markdown格式化，制作一个非常可读的最终文档。 在回顾我之前编写的源代码时，我发现Marginalia确实有帮助。 以下是Marginalia源自身的一个例子。
请注意，这不同于原来的文字编程工作流程，您将在其中编写文件并从中生成源代码。 通过Marginalia，你可以编写一个常规的源代码文件，并且这些文档都被取消了。 输出与文字编程所期望的类似，但这样您仍然可以在编辑器中预期语法高亮，而无需任何特殊的文字编程支持。
它与Leiningen进行互操作，我相信蛋糕，尽管我自己并没有尝试过。
Autodoc是一个容易开始的地方，也是Clojure core和Clojure contrib的产物。
易于与Maven一起使用。 我不确定插件是否存在于Leiningen或Cake。
Codox是Clojure的最新文档生成器。
链接地址: http://www.djcxy.com/p/33623.html