降价自动生成doc？

Question

我使用javadoc，以及各种不同的基于XML的doc生成系统。 Javadoc很好，基于XML的文档生成器很可怕，XML遍及评论并将评论转化为汤。

我看过markdown，而且它很容易被解析为结构化数据而且超级人类可读，这使得它非常适合于代码内注释，其中文档和明文的可读性是最大的重要性。

那里是否有基于降价的文档生成器？有什么理由说它不起作用我不知道吗？

Answer 1

退出一些可以与JavaDoc一起使用的Markdown-Doclets（f.ex。http://www.richardnichols.net/open-source/markdown-doclet/）。

也许您也对着名的doxygen工具感兴趣。它不使用Markdown，但格式与它非常相似（例如，带有-等的无序列表。）。

Answer 2

您可以尝试mdoc to generate Markdown based documentation。它读取所有.md文件并生成基于HTML的文档。它还创建了一个TOC。看看吧。