<permission> Dokumentationstag

  • Artikel

Mit dem <permission>-Tag können Sie den Zugriff auf einen Member dokumentieren. Mit der Klasse PermissionSet können Sie den Zugriff auf einen Member angeben.

Syntax

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

Parameter

member
Ein Verweis auf einen Member oder ein Feld, das von der aktuellen Kompilierungsumgebung aufgerufen werden kann. Der Compiler prüft, ob das angegebene Codeelement vorhanden ist, und übersetzt in der Ausgabe-XML member in den kanonischen Elementnamen. Setzen Sie den Namen in einfache oder doppelte Anführungszeichen.

Der Compiler gibt eine Warnung aus, wenn er nicht gefunden memberwird.

Informationen zum Erstellen eines cref Verweises auf einen generischen Typ finden Sie unter <see>.

description
Eine Beschreibung des Zugriffs auf den Member

Hinweise

Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.

Der MSVC-Compiler versucht, Verweise in einem Durchgang durch die Dokumentationskommentare aufzulösen cref . Wenn der Compiler bei Verwendung der C++-Nachschlageregeln kein Symbol findet, wird der Verweis als nicht aufgelöst markiert. Weitere Informationen finden Sie unter <seealso>.

Beispiel

// 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() {}
};

Siehe auch

XML-Dokumentation