delphi - Delphi 2007中的HelpInsight文档

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

使用三斜杠(///)注释样式比其他记录的注释样式更常用。即:{*! comment *}和{! comment }

注释必须在声明之前。对于大多数情况，这意味着将它们放置在代码的接口(interface)部分中。 (明显的异常(exception)是对于无法从当前单元外部访问并因此在实现块中声明的类型和函数。)

第一个注释不能用于函数。 (即，它必须用于类型-或至少它看起来分析器必须在HelpInsight功能起作用之前已经看到“type”关键字)

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

是否有人还有其他帮助HelpInsight正常工作的指针/技巧？

最佳答案

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

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

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

关于delphi - Delphi 2007中的HelpInsight文档，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/53198/