Delphi 2007中的HelpInsight文檔

Question

我正在使用D2007並嘗試​​使用HelpInsight功能（自D2005以來提供）來記錄我的源代碼。 我主要想讓HelpInsight工具提示工作。 通過各種網絡沖浪和實驗，我發現了以下內容：

1. 使用三斜杠（///）注釋樣式比其他記錄的注釋樣式更常用。 即： {*! comment *} {*! comment *}和{! comment } {! comment }
2. 評論必須在它們所針對的聲明之前。 對於大多數情況，這將意味着將它們放在代碼的接口部分。 （明顯的例外是對於無法從當前單元外部訪問的類型和函數，因此在實現塊中聲明。）
3. 第一條評論不能用於函數。 （即它必須是一個類型 - 或者至少看起來解析器必須在HelpInsight功能工作之前看到“type”關鍵字）

盡管遵循這些“規則”，有時幫助洞察力卻找不到我寫的評論。 一個文件沒有生成正確的HelpInsight工具提示，但如果我將此文件包含在另一個虛擬項目中，則它可以正常工作。

有沒有人有任何其他指針/技巧讓HelpInsight工作？

Answer 1

我發現了另一個警告（在我看來是“錯誤的”）

看來必須將具有HelpInsight注釋的單元顯式添加到項目中。 僅僅在編譯項目時將單元放在搜索的路徑中是不夠的。

換句話說，該單元必須包含在Project的.dpr / .dproj文件中。 （使用項目|“添加到項目”菜單選項）