我需要记录一个由Power-useer创建,开发和维护的MS-ACCESS应用程序,该应用程序已有10年的时间。

这是一个有趣的情况,因为他们想要的是手册,以便未来的开发人员可以在没有先前的领域知识的情况下进来,并及时更改前端或后端。

我想到这个小项目有一些问题:

  • 什么是一个好的手动设计创建应用程序? Microsoft Word并没有完全削减它。
  • 为了更改表单,报告,表格或其他访问对象,您需要知道什么样的事情?
  • 我还想念什么吗?有陷阱吗?
有帮助吗?

解决方案

根据我的经验,与主流语言中的程序相比,访问和基于VB6的程序受到更多的代码复制和技术债务困扰。我不确定为什么。也许这是作为“原型”或“玩具”数据库的访问的性质(尽管正确产生后可能非常强大)。

如果我不得不在减少文档的时间和减少技术债务的时间之间进行选择,例如,通过重塑,消除重复的代码,分解长功能等,我会选择后者。可维护性和可读性的改善将更大。

其他提示

您可以首先使用VBA使用MZ-Tools加载项生成一些自动代码文档。相同的加载项可以帮助您清洁未使用的变量声明,生成行号,模块中的重新排序过程,等等。

记录表格更加困难。我的建议是保留一个屏幕截图,并通过无证件应用程序获得的.txt文件。

我知道这已经关闭了很长时间,但是我不能避免增加我的2美分:
在提到的情况下,我认为要生产的最有用的文档是功能文档(在理想世界中开始发展之前应该存在的文档)。
第二是代码本身,其中包括VBA,还包括可以在访问和SQL Server中设置的字段说明。
第三是(或一组)不错的数据库图。一旦拥有,所有其余的都可以由新开发人员使用他喜欢的工具生成。
在谈到工具时,我特别喜欢并推荐:

  • MZ工具:特别是可以轻松找到哪种例程称为您查看的例程
  • 智能缩进:正确缩进代码。试图阅读不良缩进的代码使我恶心
  • sqlspec :(不免费)生成大多数数据库引擎数据库本身的HTML文档

您是否尝试过使用内置数据库记录仪?它将打印出所有表,索引,表单,控件,每个控件的每个属性。代码,SQL使用的以及几乎所有其他内容。这导致了巨大的,但只是大量的打印输出。但是,尽管在此过程中将杀死几棵树,但肯定是给老板留下深刻印象的好方法。

许可以下: CC-BY-SA归因
不隶属于 StackOverflow
scroll top