在过去一年左右的时间里，我在 Clojure 讨论列表和其他地方看到了有关记录 Clojure 代码的工具的各种公告。这些范围从像 Marginalia 这样的完整的文学编程系统，以及用于创建“Clojure in Small Pieces”一书（甚至是 emacs org-mode）的工具，到更传统的 Javadoc 风格的解决方案，例如 Autodoc，以及 Javadoc 本身。据报道可以与 Clojure 一起使用。谷歌搜索会发现其他各种工具，也许其中一些值得更多关注，当然还有一些只是用于生成文档的个人实用程序。我的问题是最好的文档工具是什么，根据您使用它们的经验，它们的相对优势和劣势是什么？迄今为止，我尚未使用过任何文档工具，并且有兴趣尝试一种或多种。
我很喜欢旁注 https://github.com/fogus/marginalia如果你想采取类似文学编程的方法。 Marginalia 遍历您的源代码，并生成 html 格式的版本，并以非常清晰的文本在代码旁边设置注释。注释可以采用 Markdown 格式，从而形成非常易读的最终文档。当回顾我前段时间编写的源代码时，我发现 Marginalia 确实很有帮助。这是根据 Marginalia 来源本身制作的示例 http://fogus.me/fun/marginalia/.
请注意，这与原始的文学编程工作流程不同，在原始编程工作流程中，您将编写一个文件并从中生成源代码。使用 Marginalia，您可以编写一个常规源代码文件，然后从中提取文档。输出与人们对文学编程的预期类似，但通过这种方式，您仍然可以在编辑器中期望语法突出显示，而无需任何特殊的文学编程支持。
它与 Leiningen 互操作，我相信蛋糕，尽管我自己没有尝试过。
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
