尽管 doxygen 也支持许多其他语言，但我在 C 和 C++ 项目中使用 doxygen 取得了良好的结果。您可以将文档放在代码的注释中，注释可以是简单的，也可以是复杂的 HTML 标记。它很容易更新，因为它是代码的一部分。您可以将构建文档作为构建过程的一部分。与 API 严格不相关的其他主题可以作为单独的 HTML 文档添加。我使用的版本不支持搜索，因此您必须添加其他产品才能搜索这些页面。因为它是 HTML，所以您可以添加代码示例、图表等。
I've had good results with doxygen on my C and C++ projects although it supports many other languages as well. You put the documentation in comments in the code that can be simple or complex HTML markup. It is very easy to update as it is part of the code. You can make building the documents part of your build process. Additional topic that are not strictly API related can be added as separate HTML documents. The version I'm using doesn't support search so you would have to add another product to search these pages. Because it is HTML you can add in code samples, diagrams, etc.
如果您使用 LaTeX，您可以获得所有文档的精美 PDF 格式并打印副本，以及能够生成 html（通过 latex2html）。 TeX 还具有全纯文本的优点，因此您可以使用您最喜欢的版本控制系统可靠地跟踪/合并它。
If you use LaTeX you can get all your documentation in great looking PDFs and printed copies, as well as being able to generate html (via latex2html). TeX has the advantage of being all plaintext, too, so you can track/merge it reliably with your favourite revision control system.
我们使用 confluence 作为我们的文档存储库。拥有公共和私人部分相当容易，并且有一个很好的所见即所得编辑器。它可以处理附件，如果您愿意，还可以保存为 PDF 文档。
We use confluence as our documentation repository. It is fairly easy to have public and private sections, and has a nice WYSIWYG editor. It can handle attachments and can be saved off as PDF documents if you like.
I've used robohelp with good results. it is plain html, but has a generation process that keeps everthing looking consistent. It can be packaged as a .hlp file with the app, or published to the website. Check it out, it is simple so you can get back to doing your job :)
一种简洁的方法是使用 DocBook。它很容易编写和理解。它也很容易解析，因为 XML 解析器是标准的，并且其他形式的文档（例如，来自注释中的嵌入文档）可以轻松转换为这种格式。
从 DocBook 源生成 PDF、HTML 或其他格式非常简单（有用于此目的的工具）。
A clean way is to use DocBook. It is easy write and undetstand. It is also easy to parse as XML parsers are standard and other forms of documentation (e.g. from the embedded documentation in comments) can be easily be transformed to this format.
It is straightforward to generate PDF, HTML og other formats from the DocBook source (tools exist for this purpose).
I've started using DokuWiki. Its not exactly what I was originally looking for (I think I was really looking for a CMS), but it does the job and some respects its better than what I originally had in mind (in particular its a wiki - I've not yet gotten as far as publishing this to our customers however so I'm not sure how well thats going to work out)
I'm using the IndexMenu plugin and the Arctic template to get a navigation tree on the left, and if I publish the wiki itself I'll use the discussion plugin to allow users to post feedback.
Currently my method of handling generated content is to use xslt templates to produce dokuwiki syntax, and write that output directrly to files / folders in the "data/pages" folder.
发布评论
评论（6）
尽管 doxygen 也支持许多其他语言，但我在 C 和 C++ 项目中使用 doxygen 取得了良好的结果。您可以将文档放在代码的注释中，注释可以是简单的，也可以是复杂的 HTML 标记。它很容易更新，因为它是代码的一部分。您可以将构建文档作为构建过程的一部分。与 API 严格不相关的其他主题可以作为单独的 HTML 文档添加。我使用的版本不支持搜索，因此您必须添加其他产品才能搜索这些页面。因为它是 HTML，所以您可以添加代码示例、图表等。
I've had good results with doxygen on my C and C++ projects although it supports many other languages as well. You put the documentation in comments in the code that can be simple or complex HTML markup. It is very easy to update as it is part of the code. You can make building the documents part of your build process. Additional topic that are not strictly API related can be added as separate HTML documents. The version I'm using doesn't support search so you would have to add another product to search these pages. Because it is HTML you can add in code samples, diagrams, etc.
如果您使用 LaTeX，您可以获得所有文档的精美 PDF 格式并打印副本，以及能够生成 html（通过 latex2html）。 TeX 还具有全纯文本的优点，因此您可以使用您最喜欢的版本控制系统可靠地跟踪/合并它。
If you use LaTeX you can get all your documentation in great looking PDFs and printed copies, as well as being able to generate html (via latex2html). TeX has the advantage of being all plaintext, too, so you can track/merge it reliably with your favourite revision control system.
我们使用 confluence 作为我们的文档存储库。拥有公共和私人部分相当容易，并且有一个很好的所见即所得编辑器。它可以处理附件，如果您愿意，还可以保存为 PDF 文档。
We use confluence as our documentation repository. It is fairly easy to have public and private sections, and has a nice WYSIWYG editor. It can handle attachments and can be saved off as PDF documents if you like.
我使用过 robohelp 并取得了良好的效果。它是纯 html，但有一个生成过程，可以使所有内容看起来一致。它可以与应用程序打包为 .hlp 文件，或发布到网站。看看吧，这很简单，这样你就可以回去做你的工作了:)
I've used robohelp with good results. it is plain html, but has a generation process that keeps everthing looking consistent. It can be packaged as a .hlp file with the app, or published to the website. Check it out, it is simple so you can get back to doing your job :)
一种简洁的方法是使用 DocBook。它很容易编写和理解。它也很容易解析，因为 XML 解析器是标准的，并且其他形式的文档（例如，来自注释中的嵌入文档）可以轻松转换为这种格式。
从 DocBook 源生成 PDF、HTML 或其他格式非常简单（有用于此目的的工具）。
A clean way is to use DocBook. It is easy write and undetstand. It is also easy to parse as XML parsers are standard and other forms of documentation (e.g. from the embedded documentation in comments) can be easily be transformed to this format.
It is straightforward to generate PDF, HTML og other formats from the DocBook source (tools exist for this purpose).
我开始使用 DokuWiki。它并不完全是我最初想要的（我想我真的在寻找一个 CMS），但它完成了工作，并且在某些方面比我最初的想法更好（特别是它是一个 wiki - 我还没有不过，我已经将其发布给我们的客户了，所以我不确定效果如何）
我正在使用 IndexMenu 插件和 Arctic 模板来获取导航树在左侧，如果我发布 wiki 本身，我将使用 讨论插件 来允许用户发布反馈。
目前，我处理生成内容的方法是使用 xslt 模板生成 dokuwiki 语法，并将输出直接写入“data/pages”文件夹中的文件/文件夹。
I've started using DokuWiki. Its not exactly what I was originally looking for (I think I was really looking for a CMS), but it does the job and some respects its better than what I originally had in mind (in particular its a wiki - I've not yet gotten as far as publishing this to our customers however so I'm not sure how well thats going to work out)
I'm using the IndexMenu plugin and the Arctic template to get a navigation tree on the left, and if I publish the wiki itself I'll use the discussion plugin to allow users to post feedback.
Currently my method of handling generated content is to use xslt templates to produce dokuwiki syntax, and write that output directrly to files / folders in the "data/pages" folder.