记录Visual Basic 6.0代码

Question

我刚刚被要求记录一个人完成了10年的VB6开发.自从我自己查看VB6代码已经有一段时间了,所以我基本上想知道是否有人有任何关于如何最好地解决它的提示.

是否有任何好的软件,无论是否免费,哪些类似于VB6的javadoc,这可能会有所帮助？

或者,如果有人对如何执行此操作的工具/方法有任何建议.任何提示将不胜感激.

Answer 1

您可能会发现我的插件Atomineer Pro 文档很有帮助。它可以生成和更新源代码（Visual Basic、C#、C++/CLI、C++、C、Java、unrealscript）中的 JavaDoc、Qt、Doxygen 和 Xml 文档注释，并且您可以对其生成的格式进行大量控制。

（编辑：请注意，此插件仅适用于 2005 年以后的 Visual Studio 版本，因此您不能在 VB6 中使用它，只能使用较新版本的 Visual Studio 记录旧的 VB6 代码。但是，一旦记录下来，它仍然可以在 VB6 中重新加载并编译）

（您可以说它为您生成“样板”文档，但它生成的不仅仅是基本样板框架 - 它填充了尽可能多的细节，以最大限度地减少您需要编写的附加文档的数量）

因此它不会根据注释创建外部文档（如 JavaDoc），而是自己创建注释 - 因此您仍然需要另一个工具来生成外部文档。但是，如果您必须为现有（未记录的）代码生成新的文档注释，或者您已经以 Javadoc 样式注释/记录了代码，AtomineerUtils 可以处理文档注释以将其转换为 Doxygen，那么 AtomineerUtils 可以节省大量时间或 XML 文档格式，这可以帮助您获得与可以为您构建外部文档的其他工具（Sandcastle 等）的兼容性。

为了从源代码注释生成外部文档，Doxygen是一个领先的（免费的）外部文档生成工具，它可以从 JavaDoc、Qt、Doxygen 或 Dcoumentation-XML 格式的文档注释构建文档，非常值得尝试。