.net - 在XML文档中使用指向方法参数的链接会导致SandCaSTLe生成的帮助文件中的链接断开

Question

当<see cref=""/>指向方法的参数时，我在正确解析<see>标记中的链接时遇到问题。

这是一个例子:

<summary>
My method.
</summary>
<param name="arg1">Arg1</param>
<param name="arg2">Arg2</param>
<exception cref="ArgumentNullException">Either <see cref="arg1"/>
or <see cref="arg2"/> is <c>null</c></exception>
public void MyMethod(object arg1, object arg2)
{
  // code here...
}

生成XML文档文件后，两个标签都将转换为:

<see cref="!:arg1"/>
<see cref="!:arg2"/>

当SandCaSTLe从上述XML文件生成帮助文件时，会出现以下警告:

Warn: ResolveReferenceLinksComponent2: Unknown reference link target '!:arg1'
Warn: ResolveReferenceLinksComponent2: Invalid reference link target '!:arg1'
Warn: ResolveReferenceLinksComponent2: Unknown reference link target '!:arg2'
Warn: ResolveReferenceLinksComponent2: Invalid reference link target '!:arg2'

毕竟，输出帮助文件包含指向arg1和arg2的断开链接。

有谁知道如何解决这个问题？

Answer 1

标记不适用于引用参数。请改用<paramref>。