我正在使用D2007并尝试使用HelpInsight功能(自D2005以来提供)来记录我的源代码.我主要想让HelpInsight工具提示工作.通过各种网络冲浪和实验,我发现了以下内容:
使用三斜杠(///)注释样式比其他记录的注释样式更常用.即: {*! comment *}
和{! comment }
评论必须在它们所针对的声明之前.对于大多数情况,这将意味着将它们放在代码的接口部分.(明显的例外是对于无法从当前单元外部访问的类型和函数,因此在实现块中声明.)
第一条评论不能用于函数.(即它必须是一个类型 - 或者至少看起来解析器必须在HelpInsight功能工作之前看到"type"关键字)
尽管遵循了这些"规则",但有时帮助洞察力却找不到我写的评论.一个文件没有生成正确的HelpInsight工具提示,但如果我将此文件包含在一个不同的虚拟项目中,它可以正常工作.
有没有人有任何其他指针/技巧让HelpInsight工作?