Marca de documentação <permission>

A marca <permission> permite documentar o acesso de um membro. PermissionSet permite que você especifique o acesso a um membro.

Sintaxe

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

Parâmetros

member
Uma referência a um membro ou campo disponível para ser chamado do ambiente de compilação atual. O compilador verifica se o elemento de código fornecido existe e converte member no nome de elemento canônico no XML de saída. Coloque o nome entre aspas simples ou duplas.

O compilador emite um aviso se não encontrar member.

Para obter informações sobre como criar uma referência cref para um tipo genérico, confira <see>.

description
Uma descrição do acesso ao membro.

Comentários

Compile com /doc para processar comentários de documentação em um arquivo.

O compilador do MSVC tentará resolver as referências cref em uma passagem pelos comentários da documentação. Se o compilador não encontrar um símbolo ao usar as regras de pesquisa do C++, a referência será marcada como não resolvida. Para obter mais informações, consulte <seealso>.

Exemplo

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

Confira também

Documentação XML