Etiqueta de documentación <permission>

La etiqueta <permission> le permite documentar el acceso de un miembro. PermissionSet permite especificar el acceso a un miembro.

Sintaxis

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

Parámetros

member
Referencia a un miembro o campo al cual se puede llamar desde el entorno de compilación actual. El compilador comprueba si el elemento de código dado existe y traduce member al nombre de elemento canónico en la salida XML. Ponga el nombre entre comillas simples o dobles.

El compilador emite una advertencia si no encuentra member.

Para información sobre cómo crear una referencia cref a un tipo genérico, consulte <see>.

description
Descripción del acceso al miembro.

Comentarios

Compile con /doc para procesar los comentarios de documentación a un archivo.

El compilador de MSVC intentará resolver las referencias cref en una pasada por los comentarios de documentación. Si el compilador no encuentra un símbolo al usar las reglas de búsqueda de C++, la referencia se marcará como sin resolver. Para obtener más información, vea <seealso>.

Ejemplo

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

Consulte también

Documentación de XML