问题标签 [documentation-generation]

是否有工具可以跟踪/绘制 Ada 源代码中的标头依赖关系？

我最近一直在使用名为“WinMerge”的应用程序进行文档比较，但我的团队脚本文件的一个要求（用于审计目的）是，当我们发布脚本的修订版时，我们会以红色突出显示更改（RTF 格式我相信，它是通过 Lotus Notes）为此，是否有任何软件可以自动为我突出显示更改，或者是最好的我将获得差异列表并期望手动突出显示所有更改？

我想用Hanna模板生成Ruby 文档。

怎么做？或者如果有的话我在哪里可以下载？

使用

rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna

给我缺少方法的文档。似乎它不会生成用 C 编写的方法。

我想知道是否有人知道自动生成 oracle 9i 数据库模式文档的好工具。我进行了重新搜索，到目前为止找到了 DBSribe(www.leadum.com)，但我遇到了问题，因为它在执行文档生成过程时给了我一个错误。任何帮助将不胜感激。

提前致谢。

我有一个要分发的 Flash (AS3) 组件库，我想确保每个版本都有完整的文档记录。我真正喜欢 Microsoft 为 C# 自动生成文档的一件事是，我可以让我的编译器为任何未以文档标记格式记录的公共成员生成警告（在每次编译时）。

我发现这对我确保我已经完全记录了我的所有代码非常有帮助。

有没有办法为 ASDoc 打开类似的东西？

感谢您提供的任何建议和技巧——我希望在 Eclipse / Flex Builder 中使用它，但我可以使用 Ant。

任何人都知道生成跨越整个 wiki 的 PDF 文件或 CHM 文件的 wiki 或 wiki 插件？

• 我想控制目录。
• 我希望内部和外部链接能够正常工作。
• 理想情况下允许调整输出模板，但这不会破坏交易。

我想使用 WIKI 语法和思维方式（大量的交叉链接等）生成内容，但以 PDF、CHM 或嵌入式应用程序表单的形式发送内容。比在最终用户机器上安装 wiki 软件更友好的东西...

我正在寻找可以满足此类要求的帮助/文档生成工具：

• 它应该支持 c# 编译器生成的 xmldoc 注释，或者（甚至更好）直接支持 sandcastle
• 它应该支持导入 MS Word 文档。
• 它应该支持创建从概念文档到源代码生成的参考文档的链接。
• 如果它支持 MS Word 中的概念文档创作，那就太好了

更多细节。我的项目是.NET 的框架/库。它有几个 VS 解决方案，总共有 50 多个 C# 项目。首先，我想从我的项目的源代码中生成帮助（未来的 chm & help2 & help3）。我将该文档称为“参考文档”。沙堡（尤其是使用SCFB) 可以很好地做到这一点。但是（我想这是很常见的情况）我有一些关于框架/库的附加文档。该文档位于 MS Word 文件中（5-10 个文件）。我将该文档称为“概念文档”。我想用概念文档和参考文档（如 MSDN）制作一个可靠的帮助系统。我希望帮助的概念部分包含链接（URL），这些链接引用了来自框架/库的每个 .NET 类型名称的帮助的参考部分。（显然任何帮助系统最终都只是 HTML）。

问题是如何创建这些链接。MS Word 文件对 C# xmldoc 一无所知。Sandcastle 不支持 Word 文件。所以我必须采取一些帮助创作工具（HAT）。到目前为止，我找不到任何适合我的工具。如果有任何帮助，我将不胜感激！

所有工具的绊脚石是链接自动创建。我希望在生成期间自动创建链接（可以在构建服务器上进行）。为什么会自动？因为它允许轻松重命名类型。例如。我在概念文档中有一些文本：“用于访问请求处理上下文使用 XOperationContext 类型的静态属性 Current”。这里 XOperationContext 是一个类型名称。我希望它成为结果帮助系统中 XOperationContext 类规范的链接（URL），而无需付出任何重大努力。我想在 Word 中（可能安装了一些 HAT 的插件）或在 HAT 的编辑器中将其标记为“如果可能，请制作此单词链接”。在生成过程中，如果存在具有此类名称的类型名称，则每个此类单词都将成为链接。

我知道这些工具：

• Toolsfactory Doc-o-Matic（现在使用）
• Innovasys DocumentX 和 HelpStudio
• ComponentOne 文档帮助

Doc-o-Matic 支持链接自动创建。真正自动。它尝试为 PascalCase 中的每个单词创建一个链接——非常出色。但它不支持 MS Word。Innovasys 和 ComponentOne 的软件不支持自动创建链接。Innovasys 的软件不支持 MS Word（对此我不确定 100%）。

我试图在 Innovasys 和 ComponentOne 的论坛上提问。到目前为止没有运气。Innovasys 的软支持方案和我的一样：在单独的工具 - HelpStudio 中创建概念文档，并使用另一个工具 - DocumentX 从源代码生成帮助。但是无法自动创建链接和导入 MS Word 文件。

因此，请分享您对该常见任务的过期时间（我相信它应该是常见的）。

ps如果我没有从英语语法的角度正确解释我的想法，请告诉我，我会再试一次。

Sphinx是一个新的 Python 文档工具。它看起来非常漂亮。我想知道的是：

• 这对于记录 C++ 项目有多合适？
• 是否有任何工具可以将现有文档（例如 doxygen）转换为 Sphinx 格式？
• 是否有使用 Sphinx 的 C++ 项目的在线/可下载示例？
• 使用过 Sphinx 的人有什么建议吗？

我最近一直在研究 CruiseControl 配置（我是一个完整的 CC 菜鸟），到目前为止，我了解您的构建过程生成的各种 XML 报告（例如 mbunit.xml、ncover.xml、fxcop.xml）可以显示在通过向 ccnet.config 的以下部分添加对 xml 的引用来控制仪表板：

添加一个 xsl 文件以将 xml 转换为可呈现的 html，并将报告构建插件添加到引用 xsl 的dashboard.config：

我的问题是：如果我有一些纯 HTML 的报告（由 JGregory 的 Docu 生成的代码文档和由 jpboodhoo 的 Bdddoc 生成的测试规范），有什么方法可以以类似的方式在仪表板中显示这些？我想不通。我确实想过将 ExternalLink 直接添加到 HTML 页面，但这是在用户通常无法访问的受保护区域中。有人有什么想法吗？

Sphinx 支持几种输出格式：

• 多个 HTML 文件（带html或dirhtml）
• 乳胶可用于创建.pdf或.ps
• 文本

我怎样才能获得 Microsoft Word 文件中的输出？

使用另一个文档生成器，我设法生成了一个 html 输出文件，然后使用 Word 应用程序将其转换为 Microsoft Word 格式。

不幸的是，我不知道生成 Word 或 HTML 单页格式的方法。