Delphi 2010中的C#样式XML注释

Question

Delphi 2010是否具有类似C#的XML注释，当悬停在方法调用上时会显示出来？

/// <summary>
/// My comment here
/// </summary>

- Stefan Schultze

Answer 1

我刚在D2007中尝试了一下，它可以正常工作。我把你的测试注释放在方法声明之上（类声明内部），然后重新构建。现在当你悬停在对该方法的调用上时，你会在工具提示中看到“我的评论在这里”。

要使此功能正常工作，您必须启用HTML评估设置。请参见选项->编辑器选项->代码洞察->符号说明（从德语IDE翻译）。

- Uli Gerhardt

---

我之前因为性能原因实际上已经停用了这个功能 - 谢谢！ - Stefan Schultze

我通常也将其禁用。 :-) - Uli Gerhardt

请注意，尽管它可以工作，但我还没有找到任何有关在Delphi中使用此代码的单一文档，除了“它存在并且可以与我们的帮助弹出窗口一起使用”的说明 - 没有关于支持哪些元素的内容，甚至没有提示说“我们使用了C＃使用的内容”。我知道CNPack将这些元素添加到代码完成弹出窗口中-其他插件我不确定。 - Michael Madsen

Answer 2

它确实可以工作 - 在Delphi 2007和2009中存在问题 - 您必须在每个类之前加上一个type关键字，否则它只会选择第一组文档（不知道为什么），如果您点击“生成XML文档”选项，则在编译大量单元时似乎会丢失并放弃 - 我希望这在Delphi 2010中得到修复。尽管如此，内联文档比没有文档要好！您可以通过Embarcadero的此链接找到相关信息，虽然我认为在Delphi的Architect和Enterprise版本中有工具可以生成外部文档。

- mmmm

Answer 3

关于这个问题目前没有太多的文档可供参考，不过 Delphi Wiki 上有一篇小 文章。Marco Cantu 也在他的博客上写了几篇短文，这里 和 这里。

- Alister