delphi - Delphi 2007 中的 HelpInsight 文档

Question

我正在使用 D2007，并尝试使用 HelpInsight 功能(自 D2005 起提供)记录我的源代码。我主要对让 HelpInsight 工具提示正常工作感兴趣。通过各种网上冲浪和实验，我发现了以下内容:

1. 使用三斜杠 (///) 注释样式比其他记录的注释样式更有效。即:{*!评论 *} 和 {!评论 }
2. 注释必须位于其所属声明之前。对于大多数情况，这意味着将它们放置在代码的接口(interface)部分。 (明显的异常(exception)是无法从当前单元外部访问的类型和函数，因此在实现 block 中声明。)
3. 第一个注释不能针对函数。 (即它必须针对某种类型 - 或者至少看起来解析器必须在 HelpInsight 功能起作用之前已经看到“type”关键字)

尽管遵循这些“规则”，有时帮助洞察就是找不到我写的评论。一个文件不会生成正确的 HelpInsight 工具提示，但如果我将此文件包含在不同的虚拟项目中，它就会正常工作。

是否有人还有其他让 HelpInsight 正常工作的指示/技巧？

Answer 1

我发现了另一个警告(就我而言，这就是“错误”)

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

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