Delphi 2007 中的 HelpInsight 文档答案

【问题标题】：HelpInsight documentation in Delphi 2007Delphi 2007 中的 HelpInsight 文档
【发布时间】：2008-09-10 00:04:15
【问题描述】：

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

使用三斜杠 (///) 注释样式比其他记录的注释样式更有效。即：{*! comment *} 和 {! comment }
cmets 必须位于它们所针对的声明之前。在大多数情况下，这意味着将它们放在代码的接口部分。（明显的例外是不能从当前单元外部访问并因此在实现块中声明的类型和函数。）
第一条评论不能针对函数。（即它必须是一个类型 - 或者至少看起来解析器必须在 HelpInsight 功能工作之前看到“type”关键字）

尽管遵循这些“规则”，有时 Help-insight 还是找不到我编写的 cmets。一个文件无法生成正确的 HelpInsight 工具提示，但如果我将此文件包含在不同的虚拟项目中，它可以正常工作。

有没有人有任何其他提示/技巧可以让 HelpInsight 发挥作用？

【问题讨论】：

【解决方案1】：

我发现了另一个警告（在我的情况下是“错误”）

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

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

【讨论】：

在古老的 Borcadero 传统中，这一事实仍未记录在案。
除了你的提示，我还发现了另一个问题。然后你有一个不在类中的函数/过程，你需要在实现部分调用它“.”，否则HelpInsight只会显示“declared in ...”