XMLドキュメントで、メソッドグループへの参照を挿入できますか?どうやって?

StackOverflow https://stackoverflow.com/questions/1411859

質問

C#では、プロパティ、メソッド、イベントなどのドキュメントを添付できますが、 XMLドキュメントコメントを使用して、コード内で直接。

特定のメソッドへの参照を挿入する方法を知っています:

<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>

メソッドグループへの参照を挿入する方法はありますか?同じメソッド名のオーバーロードが複数ある場合...

試しました

<see cref="M:MethodName"/>

..しかし、それは機能しませんでした。

編集:バンプ

役に立ちましたか?

解決

どうやらこれを行う方法はありません。

他のヒント

これは少なくともVisual Studio 2012で修正されたようです:

<see cref="MethodName"/>

警告を生成します:

  

cref属性のあいまいな参照: 'MethodName'。 「&#8230;」を想定していますが、「&#8230;」を含む他のオーバーロードにも一致する可能性があります。

ただし、前に M:を追加すると、警告がなくなります:

<see cref="M:MethodName"/>

これはサンドキャッスルでサポートされるようになりました。

メソッドグループを参照するには、次の構文が必要です。

/// <summary>
/// Reference to a method group with two items:
/// <see cref="O:Full.Declaring.Namespace.TypeName.Foo"/>
/// </summary>
void Foo() { }
void Foo(int x) { }

このC#言語機能リクエストで説明されているように、この構文にはまだいくつかの制限があることに注意してください

  • 構文は、ビルド中に検証されません。入力中に発生したエラーは、Sandcastle Help File Builderがコメントを処理するかどうか/いつまで報告されません。
  • 同じ名前のメソッドが複数ある場合、のみの構文が機能します。
  • この構文には、構文の強調表示やエディターのサポートはありません。
ライセンス: CC-BY-SA帰属
所属していません StackOverflow
scroll top