记录Visual Basic 6.0代码

Question

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

是否有任何好的软件，无论是免费的还是没有，这些软件会为VB6做类似的javadoc，这可能会有所帮助吗？

或者，如果有人对如何执行此操作的工具/方法有任何建议。任何提示都将非常感激。

Answer 1

您可以尝试VBDox，这是一个免费的VB6源代码文档生成器。

Answer 2

我曾经在VB6中编写过一段时间以前的代码，而且我从来没有遇到任何有助于Javadoc意义上的文档的工具。

我会从需要记录的角度来处理这个问题：开发人员是理解API还是让用户使用应用程序？假设前者，那么开发人员可以跟踪正在发生的事情的最低限度是什么？您可以避免记录每个方法，并且只提供一个通用的挥动用例的方法，可以完全独立于代码并基于您的探索。一些好的图表对转移理解有很长的路要走。

如果是用户使用该应用程序，那么您将进入帮助编译器的领域。您可能很幸运，并且仍然可以找到其中一个：http://help-compiler.qarchive.org/

或者，如果它必须等同于Javadocs或者您没有得到报酬，那么您可能需要考虑编写一个工具来扫描源代码并为您填写大部分样板参数。像Unix AWK这样的工具可以在这里提供帮助。

Answer 3

我们的VBdocman完全符合您的需求。它使用javaDoc注释，它可以生成多种输出格式。

Answer 4

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

（编辑：请注意，此插件仅适用于2005年以后的Visual Studio版本，因此您无法在VB6中使用它，只能使用较新版本的Visual Studio记录旧的VB6代码。它当然可以在VB6中重新加载和编译

（你可以说它为你生成了“样板文件”文档，但它产生的不仅仅是一个基本的样板骨架 - 它尽可能详细地填写，以尽量减少你需要写的额外文档的数量）

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

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