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 に答える