1

当指向方法的参数时,我在正确解析<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 的断开链接。

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

4

1 回答 1

4

<see> 标签不用于引用参数。请改用<paramref>

于 2012-05-29T12:37:54.633 回答