<permission> ドキュメント タグ

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

構文

/// <permission cref="member">description</permission>

パラメーター

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

コンパイラでは、member が見つからない場合に警告を発行します。

ジェネリック型への cref 参照を作成する方法については、「<see>」を参照してください。

description
メンバーへのアクセスの説明です。

Remarks

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

MSVC コンパイラでは、ドキュメント コメントを通じて 1 回渡すことで cref 参照を解決しようとします。 C++ のルックアップ規則を使用しているときにコンパイラによってシンボルが見つからない場合、参照は未解決としてマークされます。 詳細については、「<seealso>」を参照してください。

// xml_permission_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_permission_tag.dll
using namespace System;
/// Text for class TestClass.
public ref class TestClass {
   /// <permission cref="System::Security::PermissionSet">Everyone can access this method.</permission>
   void Test() {}
};

関連項目

XML ドキュメント