Vb6 编写Visual Basic 6.0代码文档
我最近被要求记录一个人10年的VB6开发。我已经有一段时间没有亲自研究VB6代码了，所以我基本上想知道是否有人对如何最好地使用它有什么建议 有没有好的软件，不管是免费的还是非免费的，可以在VB6上做一些类似javadoc的事情，这可能会有帮助Vb6 编写Visual Basic 6.0代码文档,vb6,documentation,documentation-generation,Vb6,Documentation,Documentation Generation,我最近被要求记录一个人10年的VB6开发。我已经有一段时间没有亲自研究VB6代码了，所以我基本上想知道是否有人对如何最好地使用它有什么建议 有没有好的软件，不管是免费的还是非免费的，可以在VB6上做一些类似javadoc的事情，这可能会有帮助 或者，如果有人对如何做到这一点的工具/方法有任何建议。任何提示都将不胜感激。很久以前我曾用VB6编写代码，而且我从未遇到过任何有助于Javadoc意义上的文档编写的体面工具 我将从需要记录的角度来处理这个问题：是开发人员理解API还是用户使用应用程序？假设
或者，如果有人对如何做到这一点的工具/方法有任何建议。任何提示都将不胜感激。很久以前我曾用VB6编写代码，而且我从未遇到过任何有助于Javadoc意义上的文档编写的体面工具 我将从需要记录的角度来处理这个问题：是开发人员理解API还是用户使用应用程序？假设是前者，那么你能逃脱的最低限度是多少，这样开发人员就可以跟踪到底发生了什么？您可以避免记录每个方法，只需提供一个通用的基于用例的方法，该方法可以完全与代码分离，并基于您的探索。一些好的图表对于传递理解有很大帮助 如果是由用户操作应用程序，那么您就进入了帮助编译器的领域。幸运的是，您可能会发现这批货中有一个仍然可用：
可选地，如果它必须是JavaDoc的等价物，或者你没有得到报酬，那么你可能需要考虑编写一个工具来扫描源代码，并为你做大量的样板参数填充。像这样的工具在这里真的很有用。
我们的工具正好满足您的需要。它使用javaDoc注释，可以生成多种输出格式。您可以尝试，这是一个免费的VB6源代码文档生成器。您可能会发现我的外接程序非常有用。它可以生成和更新源代码（Visual Basic，C，C++，CLI，C++，C，java，unRealScript）中的JavaDoc、Qt、doxEngy和XML文档注释，并且对它产生的格式有很多控制。 （编辑：请注意，此加载项仅适用于2005年以后的Visual Studio版本，因此您不能在VB6中使用它，只能使用较新版本的Visual Studio来记录旧的VB6代码。但是，一旦记录下来，当然仍然可以在VB6中重新加载和编译它） （您可以说它为您生成了“样板”文档，但它生成的不仅仅是一个基本的样板框架——它尽可能多地填充细节，以尽量减少您需要编写的额外文档的数量） 因此，它不会从注释中创建外部文档（如JavaDoc），而是创建注释本身——因此您仍然需要另一个工具来生成外部文档。但是，如果您必须为现有（未记录的）代码生成新的文档注释，或者如果您已经以Javadoc样式对代码进行了注释/记录，那么AtomineUrtils将节省大量时间，AtomineUrtils可以处理文档注释，将其转换为Doxygen或XML文档格式，这可能会帮助您获得与其他可以为您构建外部文档的工具（Sandcastle等）的兼容性要从源代码注释生成外部文档，它是一个领先的（免费）外部文档生成工具，可以从JavaDoc、Qt、Doxygen或Dcoumentation XML格式的文档注释生成文档，非常值得尝试。我删除了
[microsoft.visualbasic]Microsoft.VisualBasic