We don’t allow questions seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
接受
或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
发布评论
评论(2)
我讨厌回答自己的问题,但我们最终决定选择 LaTeX。
过去,我们使用 Wiki(MediaWiki 和 DokuWiki)来记录文档,但一旦您想要以格式正确的形式打印或发送文档(例如 PDF 指南),这就会被证明是有问题的。
与 Wiki 标记语言相比,LaTeX 并不复杂,但可以生成漂亮的 PDF 文件,并且还有一系列 LaTeX-to-HTML 编译器,可以生成带有图形、目录以及可点击链接和部分的不错的 HTML 文档。
I hate to answer my own questions, but we eventually decided to settle for LaTeX.
In the past we used a Wiki (MediaWiki and DokuWiki) for documentation, but that proved to be problematic as soon as you wanted to print or ship the documentation in a decently formatted form (PDF guide for instance).
LaTeX is not much more complex compared to a Wiki markup language, but produces beautiful PDF files, and there are also a series of LaTeX-to-HTML compilers, which produce decent HTML documentation with graphics, Tables Of Contents and clickable links and sections.
如果您使用 JavaScript 编写应用程序,您可能希望查看 JSDoc。
对于其他语言,Doxygen 也是一个不错的选择。 http://www.doxygen.nl/
Doxygen 可以输出 HTML 和 PDF 格式 =)
要获得更全面的文档生成器列表,维基百科和 Google 是您的朋友。 http://en.wikipedia.org/wiki/Comparison_of_documentation_generators
祝你好运
编辑< /strong>
好的,Thread 发布者宣布他已经使用了 Doxygen。然而,维基百科页面仍然存在,我想
我可以问一下你正在使用什么语言吗?
If you're writing your application in JavaScript, you might wish to look at JSDoc.
For other languages, Doxygen is a good choice, too. http://www.doxygen.nl/
Doxygen can output HTML and PDF formats =)
For a more comprehensive list of documentation generators, Wikipedia and Google are your friends. http://en.wikipedia.org/wiki/Comparison_of_documentation_generators
Good luck
Edit
Ok, Thread poster has announced he used Doxygen already. However, the wikipedia page still stands, I guess
Might I ask what language you're working with?