问题标签 [documentation-generation]

我需要为新员工记录遗留数据库架构，并且由于没有设计文档，我想从现有架构生成一个。由于这些表是 MyISAM，因此外键关系不会产生漂亮的图表。我有兴趣制作一份显示重要表格、它们的列、类型和备注的文档。

是否有任何工具可用于从数据库模式元数据生成漂亮的文档（PDF、DOC、HTML 或 RTF）？还是我最好编写一个实用程序来自己导出它（我想将它转储到 XML，然后使用 XSLT 转换它）？该模式在 MySQL 5 上运行。

这个周末我安装了 Windows 7（太棒了！），在那里我发现了这个名为Problem Steps Recorder的天才工具。显然是 beta 错误报告工具 thingy 附带的一个工具。

我目前正在尝试为其他开发人员记录一些应用程序的使用情况。（在这种情况下，如何在 SQL Profiler 中获取 Showplan XML Statistics 以及数据库引擎优化顾问的一些基本用法）。我在想一个像问题步骤记录器这样的工具非常适合这个！唯一的问题是它只在 Windows 7（？）中，输出是一个 mht 文件，其中还包含一些一般错误问题文本等......

无论如何，有谁知道这个工具是否有更通用的版本？或者，如果有一些免费且流畅的替代方案对 Vista（以及其他 Windows 版本，如果可能的话）做同样的事情？

过去我在 C 和 C++ 中使用过 Doxygen，但现在我被 Fortran 项目所吸引，我想快速了解一下该架构。

在过去，我发现逆向工程工具在不存在架构文档的情况下很有用。

那么，有没有一种工具可以对 Fortran 代码进行逆向工程？

我尝试使用 Doxygen，但没有任何运气。我将处理两个不同的项目——一个是 Fortran 90，我认为是 Fortran 77。

感谢您的任何见解和反馈。

我意识到这可能只是猜测，但我会感谢任何对此有所了解的人的评论。诸如 MS Word COM 插件、OO 桥或自定义实现之类的东西。

我想知道的原因是我想为 php web 应用程序提供基本的在线文档编辑（真的很基本，基本上只是富文本）。我想我会将标记存储为 html 格式，然后转换为 rtf/doc 等以方便用户使用。

我正在开发一个越来越多的小玩具项目。到目前为止，文档只是我为该项目设置的 wordpress 博客中的一组页面。但是，随着时间的推移，新版本已经发布，我应该更新在线文档以匹配最新版本。

不幸的是，如果我这样做了，以前版本的文档将“消失”，因为我的文档页面已更新到最新版本，因此我决定将文档包含在发布包中，并将最新的文档在线保留为一个网页也是如此。

一个简单的想法是从 wordpress 页面获取当前文档，将它们保存到 svn 中，然后保存到发布包中，在每个新版本中重复该过程。不幸的是，我必须手动破解我得到的 HTML 来修复链接（或者我应该破解 wordpress 以使用 BASE 以便 HTML 代码很容易重新定位，这是我不想做的）。

我应该如何处理同时拥有的要求：

1. 可下载包中包含的正确版本的用户可浏览文档
2. 在线提供的最新文档（并与我的网络主题正确样式）
3. 在 svn 和实际在线内容之间保持同步（在 wordpress 中，或其他与我的 wordpress 设置非常吻合的东西）
4. 便于使用

谢谢

编辑：开始赏金，看看我是否能引诱更多答案。我认为这是一个相当重要的问题，如果能给未来的读者多点提示和意见，那就太好了。

我目前使用 ActiveX 控件从弹出窗口中打印出一个 html 文档而不提示用户。我从不喜欢这种方法，终于开始重新考虑这个问题。

我决定使用 Java 小程序，并且已经设法使无提示打印工作。但是，我没有使用 Java 生成文档的经验，并且正在尝试获得一些关于起点的建议。

我想知道对于开发人员正在使用的项目文档，Apache Forrest产品是否有更多当前和有效的替代工具？自 2007 年以来，它似乎一直停留在 v0.8 版本中。

我正在考虑使用maven sitevia Ant 为我的项目生成包含各种 javadoc、pmd 和 findbug 报告的 HTML 报告。只是想知道其他开发人员正在使用什么。

我想将部分源代码添加到 XML 文档中。我可以将源代码复制并粘贴到一些 <code> 元素，如下所示：

保持这种状态会很痛苦。是否有其他可能性可以将源代码添加到 C# 中的 XML 文档？

我正在使用 Sandcastle 处理 XML 文档，并希望从中制作一个技术帮助文件 (*.chm)。我想将部分或完整的方法主体添加到该帮助文件中。

编辑： 感谢 slide_rule 的评论。我添加了一个更现实、更简单的例子：

假设我有这样的方法：

如果有可能将如何计算费用的信息添加到技术帮助文件中，那就太好了。

最明显的解决方案是将算法作为平淡无奇的文本写到评论中，例如：“如果账单的总金额小于 5000 则......”。

另一种解决方案是将方法的主体复制并粘贴到注释字段中，然后将其放入 <code> 元素中。这个方法体可以很容易地理解，即使没有太多关于 C# 的知识——所以把它放在技术帮助文件中没有错。

这两种解决方案都违反了 DRY 原则！我想将方法​​体或方法体的片段添加到帮助文件中，而不重复信息。

这在 C# 中可能吗？（我认为 RDoc for Ruby 能够做到这一点，但我需要一些 C# 解决方案）

我正在开发一个主要从 ac# 应用程序使用 c++/cli 库的项目。

有没有办法让 c++/cli 中的代码注释对 Visual Studio 中的 c# 智能可见？

假设没有，那么记录 c++/cli 代码以使其更容易从 c#（当然也包括在 c++/cli 中）使用的最佳方法是什么？您对 XML 注释、doxygen 和其他工具（哪个）有何看法？

很长一段时间以来，当我有一个错误处理程序时，我会让它报告错误被抛出的项目、模块和过程。我总是通过简单地通过常量存储它们的名称来实现这一点。我知道在一个类中，您可以使用 TypeName(Me) 以编程方式获得名称，但显然这只会让我获得三分之二的信息，而且只有当我不在“标准”模块中时。

我在使用常量方面并没有什么大问题，只是人们并不总是让它们保持最新状态，或者更糟糕的是，他们复制和粘贴，然后你报告了错误的名称，等等。所以我想要什么要做的是找出一种方法来摆脱示例中显示的常量，而不会丢失信息。

有谁知道如何让代码告诉它在哪里？如果您可以最终证明它无法完成，那也是一个答案:)

编辑：
我也知道项目名称在 Err.Source 中。我希望能够毫无例外地获得它用于其他目的。如果您知道得很好，否则我们可以将其定义为超出问题的范围。
我也知道如何获取错误行，但是在不知道 Module.Procedure 的情况下，这些信息当然只是有些帮助。