<permission>
тег документации
Тег <permission>
позволяет документировать уровень доступа для элемента. PermissionSet позволяет задать уровень доступа для члена.
Синтаксис
/// <permission cref="member">description</permission>
Параметры
member
Ссылка на член или поле, которые доступны для вызова из текущей среды компиляции. Компилятор проверяет, существует ли элемент кода, и приводит member
к каноническому имени элемента в выходных XML-данных. Заключите имя в одинарные или двойные кавычки.
Компилятор выдает предупреждение, если он не находит member
.
Сведения о создании ссылки на универсальный cref
тип см. в разделе <see>
.
description
Описание уровня доступа для члена.
Замечания
Скомпилируйте их для /doc
обработки примечаний документации к файлу.
Компилятор MSVC попытается разрешить cref
ссылки в одном проходе через комментарии документации. Если компилятор не находит символ при использовании правил подстановки C++, ссылка будет помечена как неразрешенная. Дополнительные сведения см. в разделе <seealso>
.
Пример
// 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() {}
};