从VB脚本代码创建文档 [英] Creating Documentation from VB Script Code

查看:120
本文介绍了从VB脚本代码创建文档的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我们有一个使用VB脚本创建的大框架,这个脚本在过去几年中被创建并维护。这个代码最初有很好的记录,所有的初始函数和变量和文件都有很好的标题。



在维护的时候,代码被编码器混淆,没有跟踪新功能和更改功能的最终结果现在在我手中是一个约600个文件的代码,没有一个对它们的功能和变量的正确描述: - (



有人可以通知他们是否为VB脚本编写的这种类型的代码创建了文档(即时类型 - dOxygen等)?

解决方案

以前我写了一个脚本( VBSdoc ) ,所以我可以在我的脚本中使用类似Javadoc的注释,并从中生成文档,但是没有适当的注释,它只会列出常量,变量,函数和类,不知道对你有多么有用,而且没有用项目o测试它f这个大小。我会对反馈感兴趣,但是,如果你想试一试。


We have a large framework created using VB Script, which has been created and then maintained for the past few years. This code was initially well documented and all the initial functions and variables and files had good headers in them.

Later in maintainence, the code got obfuscated by the coders not keeping track of new and changed functionality and the final result now in my hands is a code which has around ~600 files and none of them have the proper description of the functions and variables in them :-(

Could someone inform if they have created documents (on the fly types - dOxygen, etc.) for this type of code written in VB Script?

解决方案

A while ago I wrote a script (VBSdoc), so I could use Javadoc-like comments in my scripts and generate documentation from them. However, without proper comments it will merely list constants, variables, functions and classes. Not sure how helpful that'd be to you. Also, I have never tested it with a project of this size. I'd be interested in feedback, though, should you want to give it a try.

这篇关于从VB脚本代码创建文档的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆