记录开发人员的访问应用程序

时间:2010-05-26 19:59:16

标签: ms-access documentation manual

我需要记录由超过10年的高级用户完全创建,开发和维护的MS-Access应用程序。

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

对于这个小项目,我有几个问题:

  • 什么是好的手动设计创建应用程序? Microsoft Word并没有完全削减它。
  • 开发人员需要了解哪些内容才能对表单,报表,表格或其他Access对象进行更改?
  • 我错过了什么?有任何陷阱吗?

4 个答案:

答案 0 :(得分:3)

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

记录表格更加困难。我的建议是保持一个屏幕截图,同时使用通过未记录的application.saveAstext方法获得的.txt文件。

答案 1 :(得分:2)

根据我的经验,基于Access和VB6的程序比主流语言的程序更多地受到代码复制和技术债务的困扰。我不知道为什么。也许这是Access作为“原型”或“玩具”数据库的本质(尽管在正确屈服时它可能非常强大)。

如果我不得不在文件上花费时间和花时间减少技术债务之间做出选择,例如通过重新模块化,消除重复代码,拆分长函数等,我会选择后者。可维护性和可读性的提高会更大。

答案 2 :(得分:1)

我知道这已经关闭了很长时间,但我无法克制我的2美分:
在提到的案例中,我认为最有用的文档是一个功能文档(在理想世界中开始开发之前应该存在)。
其次是代码本身,包括VBA以及可以在Access和SQL Server中设置的字段描述 第三个是一个(或一组)好的数据库图。 完成后,所有其他人都可以使用HIS最喜欢的工具由新开发人员生成 谈到工具,我特别喜欢并推荐:

  • MZ工具:专门用于轻松找到哪个例程调用您正在查看的例程
  • 智能缩进:正确缩进代码。试图阅读错误的缩进代码会让我感到恶心
  • SqlSpec :(非免费)为大多数数据库引擎生成数据库本身的HTML文档

答案 3 :(得分:0)

您是否尝试过使用内置数据库文档?它将打印出所有表,索引,表单,控件,控件的每个属性。代码,使用的sql和其他任何东西。这导致巨大的,但只是大量的打印输出。然而,虽然它会在这个过程中杀死一些树,但它确实是给老板留下深刻印象的好方法。