Sdílet prostřednictvím


<permission> značka dokumentace

Značka <permission> umožňuje dokumentovat přístup člena. PermissionSet umožňuje určit přístup k členu.

Syntaxe

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

Parametry

member
Odkaz na člena nebo na pole, které lze volat z prostředí aktuální kompilace. Kompilátor zkontroluje, že daný element kódu existuje a přeloží member na název kanonického elementu ve výstupním XML. Uzavřete název do jednoduchých nebo dvojitých uvozovek.

Kompilátor vydá upozornění, pokud ho nenajde member.

Informace o tom, jak vytvořit cref odkaz na obecný typ, naleznete v tématu <see>.

description
Popis přístupu k členu.

Poznámky

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Kompilátor MSVC se pokusí vyřešit cref odkazy v jednom průchodu komentáři dokumentace. Pokud kompilátor při použití vyhledávacích pravidel jazyka C++ nenajde symbol, bude odkaz označen jako nevyřešený. Další informace najdete na webu <seealso>.

Příklad

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

Viz také

Dokumentace XML