自动生成文档的标记 [英] Markdown for automatic doc generation?

问题描述

我已经使用javadoc，以及各种不同的基于XML的文档生成系统。 Javadoc很好，基于XML的文档生成器是可怕的，XML会遍历注释，并将注释变成汤。

我已经看过了markdown，事实上，它很容易解析成结构化数据，而且超级人性化可以使其成为代码注释的完美，其中文档和纯文本的可读性是非常重要的。

已经有任何基于文档生成器的降价？有没有什么理由为什么不能工作，我不知道？

解决方案

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

也许你也对着名的 Doxygen 工具。它不使用Markdown，但格式非常类似于（f。ex。无序列表与 - 等）。

I've use javadoc, as well as a variety of different XML based doc-generation systems. Javadoc is fine, XML based doc-generators are hideous, with the XML getting all over the comments and turning the comments into soup.

I've looked at markdown, and the fact that it is easily parseable into structured data but also super human-readable would make it perfect for in-code comments, where the readability of both the docs and the plaintext is of utmost importance.

Are there any markdown based doc-generators out there already? Is there any reason why it wouldn't work which I don't know of?

解决方案

There exits some Markdown-Doclets (f.ex. http://www.richardnichols.net/open-source/markdown-doclet/ ) which can be used with JavaDoc.

Maybe you are also interested in the famous Doxygen tool. It doesn't use Markdown but the format is very similar to it (f. ex. unordered lists with - etc.).

这篇关于自动生成文档的标记的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！