<permission> tag dokumentacji

Tag <permission> umożliwia dokumentowanie dostępu do elementu członkowskiego. PermissionSet umożliwia określenie dostępu do elementu członkowskiego.

Składnia

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

Parametry

member
Odwołanie do elementu członkowskiego lub pola, które jest dostępne do wywołania z bieżącego środowiska kompilacji. Kompilator sprawdza, czy dany element kodu istnieje i tłumaczy member na nazwę elementu kanonicznego w wyjściowym pliku XML. Ujęć nazwę w pojedynczych lub podwójnych cudzysłowach.

Kompilator wyświetla ostrzeżenie, jeśli nie znajdzie memberelementu .

Aby uzyskać informacje na temat tworzenia cref odwołania do typu ogólnego, zobacz <see>.

description
Opis dostępu do elementu członkowskiego.

Uwagi

Skompiluj element , /doc aby przetworzyć komentarze dokumentacji do pliku.

Kompilator MSVC podejmie próbę rozpoznania cref odwołań w jednym przekazaniu komentarzy dokumentacji. Jeśli kompilator nie znajdzie symbolu podczas korzystania z reguł odnośników języka C++, odwołanie zostanie oznaczone jako nierozwiązane. Aby uzyskać więcej informacji, zobacz <seealso>.

Przykład

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

Zobacz też

Dokumentacja XML