<permission>
balise de documentation
La <permission>
balise vous permet de documenter l’accès d’un membre. PermissionSet vous permet de spécifier l’accès à un membre.
Syntaxe
/// <permission cref="member">description</permission>
Paramètres
member
Référence à un membre ou un champ qu’il est possible d’appeler à partir de l’environnement de compilation actuel. Le compilateur vérifie que l’élément de code donné existe et traduit member
en nom d’élément canonique dans le fichier XML de sortie. Mettez le nom entre guillemets simples ou doubles.
Le compilateur émet un avertissement s’il ne trouve member
pas .
Pour plus d’informations sur la création d’une cref
référence à un type générique, consultez <see>
.
description
Description de l’accès au membre.
Notes
Compilez avec /doc
pour traiter les commentaires de documentation dans un fichier.
Le compilateur MSVC tente de résoudre cref
les références dans un seul passage par les commentaires de documentation. Si le compilateur ne trouve pas de symbole lors de l’utilisation des règles de recherche C++, la référence est marquée comme non résolue. Pour plus d’informations, consultez <seealso>
.
Exemple
// 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() {}
};
Voir aussi
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour