<permission> (C# プログラミング ガイド)

  • [アーティクル]
<permission cref="member">description</permission>

パラメータ

  • cref = "member"
    現在のコンパイル環境からの呼び出しに利用できる、メンバまたはフィールドへの参照。コンパイラは、指定されたコード要素が存在することを確認してから、member を出力先 XML 内で標準要素名に変換します。member は二重引用符 (" ") で囲みます。

    ジェネリック型への cref 参照の作成方法については、「<see> (C# プログラミング ガイド)」を参照してください。

  • description
    メンバへのアクセスの説明。

解説

<permission> タグを使用すると、メンバへのアクセスをドキュメントにできます。PermissionSet クラスは、アクセスをメンバに指定するために使用します。

コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。

使用例

// compile with: /doc:DocFileName.xml 

class TestClass
{
    /// <permission cref="System.Security.PermissionSet">Everyone can access this method.</permission>
    public static void Test()
    {
    }

    static void Main()
    {
    }
}

参照

関連項目

ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)

概念

C# プログラミング ガイド