0

我的 IVR 应用程序包含许多全局变量，这是不可避免的供应商提供的框架的副作用。因此，在很多情况下，变量在一个 JSP 上被赋予了一个值，并且在调用者深入应用程序的几个对话框之前不会再次被触及。

当我必须添加或修改这样的变量时，我会留下描述修改的序言注释，而不会详细介绍整个功能：

<%--IVRAvenger 20100927 Issue#:12345: Keep track of what the caller entered.  Used for multiple ID/ID change logic, further on. --%>
<assign name="gblIDInput" expr="memberID"/>

这是误导吗？简单地添加这些小语句，并让其他开发人员扫描代码以查找这些变量发挥其（有问题的）魔力的模块会更好吗？

谢谢，
IVR 复仇者

4

1 回答 1

0

对于这样的问题，我会推荐一个外部字典文档，其中列出了全局变量、用途和与之相关的典型工作流程。

您可能还想列出使用这些变量的主要模块。虽然这些数据会过时，但它将为难以维护您的应用程序的人提供一个起点。

如果您确实实现了这样的文档，我还将推荐代码所体现的任何整体模式或理念。包括已知的错误选择以及为什么它们是错误的选择不会受到伤害。由于大多数开发人员不会阅读（当然也不会维护）这样的文档，因此您要么是为将文档作为任务分配的新员工而写作，要么是为最终感到沮丧而无法实际阅读文档的未来维护者写作。

于 2010-11-21T15:29:14.107 回答