我最近被要求记录一位人员进行的10年VB6开发工作。自从我自己看过VB6代码以来已经有一段时间了，因此我想知道是否有任何技巧可以更好地完成这项工作。
是否有任何类似于Javadoc的好软件（免费或收费），可以帮助VB6开发文档化呢？
或者如果有任何关于如何完成这项工作的工具/方法的建议。任何提示都将不胜感激。
4个回答
3
你可以尝试使用免费的VB6源代码文档生成器VBDox。
- Kelly Ethridge
3
好的，谢谢您的提示，我希望能找到一些免费的东西。 - cc0
据我所记，VBDox需要使用Internet Explorer来显示生成的文档，这是一个很大的缺点。 - Christoph Jüngling
VBDox确实使用IE在应用程序内显示其内容（包括生成的文档），但是您可以更改设置，以便在默认浏览器中显示生成的文档。 - Kelly Ethridge
1
我很久以前曾经编写过VB6代码，但从未遇到过任何像Javadoc一样有用的文档工具。
我会从需要记录的内容入手：是为了让开发人员理解API还是为了让用户使用应用程序？假设是前者，那么您可以尽可能地提供最少的文档，以便开发人员能够跟上进展。您可以避免记录每个方法，只需提供一个基于手部挥动用例的通用方法，该方法可以与代码完全分离，并基于您的探索。一些好的图表可以大大传递理解。
如果是为了让用户使用应用程序，那么您就进入了帮助编译器的领域。您可能会很幸运地发现其中之一仍然可用：http://help-compiler.qarchive.org/
或者，如果必须与Javadocs等效，或者您没有得到报酬，那么您可能需要考虑编写一个工具来扫描源代码并为您完成大部分样板参数填充。像Unix AWK这样的工具可以真正帮助您。
- Gary
3
这里有一些不错的技巧，值得深思。谢谢。我在考虑是否需要为开发人员编写类似于javadoc的文档，然后再为使用服务器结构的人编写一些好的图表。你有什么好的图表制作技巧（应用程序）吗？我总是花费很多时间手动制作它。我知道这实际上是另一个大主题。 - cc0
在 Microsoft 的世界中，图表王者是 Visio，但做好开钱包的准备。如果你感到大胆，可以尝试一下 Graphviz（http://www.graphviz.org/Gallery.php），它允许你从纯文本编译图表，并直接在 Confluence wiki 中支持。否则，你需要询问客户希望以什么格式呈现文档，并按照要求进行工作。 - Gary
很好的提示，我以前从未使用过Visio，但现在似乎是开始研究它的时候了，我也会看看其他的，所以谢谢：] - cc0
1
你可能会发现我的插件 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 中）
（你可以说它为你生成了“样板”文档，但它生成的不仅仅是基本的模板骨架——它填写尽可能多的细节，以尽量减少您需要编写的额外文档数量）
AtomineerUtils并不像JavaDoc那样从注释中创建外部文档，而是创建注释本身 - 因此您仍需要另一个工具来生成外部文档。但是，如果您需要为现有（未记录的）代码生成新的文档注释，或者如果您已经以Javadoc风格对代码进行了注释/记录，则AtomineerUtils可以处理文档注释以将它们转换为Doxygen或XML文档格式，这可能有助于您获得与其他工具（如Sandcastle等）兼容的性能，这些工具可以为您构建外部文档。
要从源代码注释生成外部文档，Doxygen是一款领先的（且免费的）外部文档生成工具，可以从JavaDoc、Qt、Doxygen或Dcoumentation-XML格式文档注释构建文档，并值得一试。
- Jason Williams
1
非常好，我会尝试这个。我已经尝试了上面建议的VBDocman，但对输出结果并不完全满意。谢谢。 - cc0
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接
[microsoft.visualbasic]删除了，因为它是指.NET的Microsoft.VisualBasic命名空间。 - GSerg