我的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 Avenger
答案 0 :(得分：0)
对于这样的问题，我建议使用外部字典文档，列出全局变量，目的和与之相关的典型工作流程。
您可能还想列出使用变量的主要模块。虽然这些数据已经过时，但它将为难以维护您的应用程序的人提供一个起点。
如果您确实实现了这样的文档，我还会推荐代码所体现的任何整体模式或哲学。包括已知的错误选择以及为什么选择错误都不会受到伤害。由于大多数开发人员不会阅读（当然还有维护）这样的文档，因此您要么是为新员工撰写文章作为任务，要么是未来的维护人员，他们最终对实际阅读文档感到沮丧。