<seealso> タグを使用して、「関連項目」セクションに表示するテキストを指定することができます。 <see> を使用すると、テキスト内からリンクを指定できます。
構文
/// <seealso cref="member"/>
パラメーター
member
現在のコンパイル環境からの呼び出しに利用できる、メンバーまたはフィールドへの参照。 名前は、一重引用符または二重引用符で囲みます。
コンパイラは、指定されたコード要素が存在するかどうかを確認し、member を出力 XML 内の要素名に解決します。 コンパイラでは、member が見つからない場合に警告を発行します。
ジェネリック型への cref 参照を作成する方法については、「<see>」を参照してください。
解説
コンパイル時に /doc を指定して、ドキュメント コメントをファイルに出力します。
<seealso> の使用例については、<summary> を参照してください。
MSVC コンパイラでは、ドキュメント コメントを通じて 1 回渡すことで cref 参照を解決しようとします。 C++ のルックアップ規則を使用しているときにコンパイラによってシンボルが見つからない場合、参照は未解決としてマークされます。
例
次のサンプルでは、cref で未解決のシンボルが参照されます。 A::Test への cref の XML コメントは <seealso cref="M:A.Test" /> であり、これは整形式です。 一方で、B::Test への cref は <seealso cref="!:B::Test" /> になります。
// xml_seealso_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_seealso_tag.dll
/// Text for class A.
public ref struct A {
/// <summary><seealso cref="A::Test"/>
/// <seealso cref="B::Test"/>
/// </summary>
void MyMethod(int Int1) {}
/// text
void Test() {}
};
/// Text for class B.
public ref struct B {
void Test() {}
};