XML文档注释中的交叉引用

时间:2015-01-20 11:45:49

标签: delphi xml-documentation

使用XML文档注释时,我无法弄清楚如何引用另一个类成员。拿这个代码:

TGreeter = class

  ///  <summary>Says hello</summary>
  procedure Hello;

  ///  <summary>Says hello to all</summary>
  ///  <remarks>
  ///   This is the same as <see cref="Hello"/>, but it says hello to all
  ///   instead.
  ///  </remarks>
  procedure HelloAll;

end;

Help Insight显示HelloAll的帮助很好,但如果我点击Hello的链接,它什么都不做(几乎没有;鼠标指针指示,大约一秒左右,它确实一些思考,但后来停止)。制作这种交叉引用的正确方法是什么?

1 个答案:

答案 0 :(得分:1)

在我找到一个有效的语法(用Delphi XE4测试)之前,我很想知道自己:你需要输入单位名称,管道,类名,点和方法名称。

在你的例子中,假设该单位被称为“MyUnit”,那么你应该使用:

<see cref="MyUnit|TGreeter.Hello"/>