<seealso>【参照】
<see>【参照 (インライン)】
<include>【外部XMLコメント挿入】
<permission>【アクセス権】

メモ

<seealso>【参照】

  • [参照] セクションに表示
    • 子要素に指定した場合、インライン展開されずにルート指定と同等とみなす
    • オーバーロードされたメソッドの参照:
      パラメータを指定 または autoUpgrade【オーバーロード用ページリンク】属性を指定
  • 構文チェック
    • リンク先存在チェック
  • 参照:<see>【参照 (インライン)】

<see>【参照 (インライン)】

  • インラインで参照
    • オーバーロードされたメソッドの参照:
      パラメータ指定 または autoUpgrade【オーバーロード用ページリンク】属性指定
    • langword【言語キーワード】属性指定:対象言語のキーワードとして表示 (リンク無し)
      (例:C# "Nothing" → "null")
  • 参照:<seealso>【参照】

<include>【外部XMLコメント挿入】

  • 外部XMLファイルからコメント挿入
  • 複数個所への挿入・複数人での編集に有用

<permission>【アクセス権】

  • アクセス権

構文

<seealso cref="リンク先メンバ名"/> 

<seealso cref="リンク先メンバ名" 
         [qualifyHint="true"]
         [autoUpgrade="true"オーバーロード用ページリンク] />
<seealso cref="リンク先メンバ名" 
         [autoUpgrade="true"オーバーロード用ページリンク]>
リンクテキスト</seealso>

<seealso href="リンク先 URL" 
         [target="表示先 (下記参照:_blank | _self | _parent | _top)"]
         [alt="代替テキスト"] />
<seealso href="リンク先 URL" 
         [target="表示先 (下記参照:_blank | _self | _parent | _top)"]
         [alt="代替テキスト"]>
リンクテキスト</seealso>
target 属性表示先
_blank新規ウィンドウ (タブ)
_self現在フレーム
_parent現在フレームの親
_top元ウィンドウ全体 (フレーム割解除)

<see cref="リンク先メンバ名"/> 

<see cref="リンク先メンバ名" 
     [qualifyHint="true"]
     [autoUpgrade="true"オーバーロード用ページリンク] />
<see cref="リンク先メンバ名" 
     [autoUpgrade="true"オーバーロード用ページリンク]>
リンクテキスト</see>

<see href="リンク先 URL" 
     [target="表示先 (seealso 参照:_blank | _self | _parent | _top)"]
     [alt="代替テキスト"] />
<see href="リンク先 URL" 
     [target="表示先 (seealso 参照:_blank | _self | _parent | _top)"]
     [alt="代替テキスト"]>
リンクテキスト</see>

<see 
  langword="null | Nothing | nullptr |
    static | shared | virtual | Overridable | 
    true | True | false | False | abstract | MustInherit |
    sealed | NotInheritable |
    async | await | async/await | Async | Await | Async/Await |
    let! | async/let!"言語キーワード />

<include file="XMLファイル名" path="XPath" /> 

XPath例:
【ルート要素】/【サブ要素】[@id='【id 値】']/*

<permission cref="permissionTypeOrMember">アクセス権の説明</permission>

外部リンク

/// <summary>
/// メソッドの概要 (参照:<see cref="MethodSeeB"/>)
/// </summary>
/// <remarks>
///   <see langword="null"/><see langword="virtual"/>
/// </remarks>
/// <seealso cref="MethodSeeB">MethodSeeB メソッド</seealso>
/// <seealso href="https://www.google.co.jp">Google</seealso>
public void MethodSeeA() { }

/// <include file="XMLFile.xml" path="Root/SubA/*"/>
/// <remarks>
///   <include file="XMLFile.xml" path="Root/SubB[@id='Para1']/*"/>
///   <include file="XMLFile.xml" path="Root/SubB[@id='Para2']/para"/>
/// </remarks>
/// <seealso cref="MethodSeeA"/>
/// <seealso cref="MethodSeeC()">MethodSeeC()</seealso>
/// <seealso cref="MethodSeeC(int)">MethodSeeC(int)</seealso>
/// <seealso cref="MethodSeeC" autoUpgrade="true">MethodSeeC メソッド</seealso>
/// <permission cref="System.Security.PermissionSet">アクセス権の説明</permission>
public void MethodSeeB() { }

/// <summary>
/// オーバーロード1
/// </summary>
/// <overloads>オーバーロードの説明</overloads>
public void MethodSeeC() { }

/// <summary>
/// オーバーロード2
/// </summary>
/// <param name="p1">パラメータ1</param>
public void MethodSeeC(int p1) { }

【XMLFile.xml】
<?xml version="1.0" encoding="utf-8"?>
<Root>
  <SubA>
    <summary>
      メソッドの概要 (参照:<see cref="MethodSeeA"/>)
    </summary>
  </SubA>

  <SubB id="Para1">
    <para>段落1</para>
  </SubB>
  <SubB id="Para2">
    <see cref="MethodSeeA"/>
    <para>段落2</para>
  </SubB>
</Root>