評論方式：如何評論在應用中其他地方使用的內容？

Question

我的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復仇者

Answer 1

有了這樣一個問題，因爲這，我會建議一個外部字典文件，列出了全局變量，其目的和典型工作流程與它們相關聯。

您可能還想列出使用變量的主要模塊。雖然這些數據會過時，但它會爲有人難以維護您的應用程序提供一個起點。

如果你確實實現了這樣一個文檔，我還會推薦任何總體模式或哲學體現在代碼中。包括已知的不好的選擇以及爲什麼他們是不好的選擇不會傷害。由於大多數開發人員不會閱讀（當然也不會保留）這樣的文檔，因此您要麼編寫新文檔作爲任務，要麼寫一個未來的維護人員，他們終於感到沮喪以至於無法閱讀文檔。