Delphi 2007中的HelpInsight文档

Question

我正在使用D2007并尝试记录我的源代码，使用自D2005以来提供的HelpInsight功能。我主要想让HelpInsight工具提示正常工作。从各种网络冲浪和实验中，我发现以下内容：

1. 使用三斜杠（///）注释样式比其他记录的注释样式更常见。即： {*! comment *} 和 {! comment }
2. 注释必须在它们所属的声明之前。对于大多数情况，这意味着将它们放置在代码的接口部分。（明显的例外是对于不可从当前单元外部访问且因此在实现块中声明的类型和函数。）
3. 第一个注释不能用于函数。（即它必须用于类型 - 或者至少解析器似乎必须在HelpInsight功能起作用之前看到"type"关键字）

尽管遵循了这些“规则”，有时Help-insight仍然无法找到我编写的注释。一个文件没有产生正确的HelpInsight工具提示，但如果我将该文件包含在另一个虚拟项目中，则可以正常工作。

是否有其他提示/技巧可使HelpInsight正常工作？

- Andrew

---

你有没有找到更多的解决方案来使HelpInsight更加稳定？ - Daniel Marschall

Answer 1

我发现了另一个需要注意的问题（在我的情况下是“错误”）

看起来带有HelpInsight注释的单元必须显式地添加到项目中。仅仅将单元放在编译项目时搜索的路径中是不够的。

换句话说，该单元必须包含在项目的.dpr/.dproj文件中。（使用“项目”|“添加到项目”菜单选项）

- Andrew

---

而在Borcadero的传统中，这个事实仍然没有被记录下来。 - JensG

除了您提供的提示，我还发现了另一个问题。如果您有一个不在类中的函数/过程，在实现部分需要调用它时，必须使用"<unitname>.<functionname>"的方式进行调用，否则HelpInsight只会显示"声明于..."。 - Daniel Marschall