<permission>(C# 编程指南)

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

参数

  • cref = "member"
    对可以通过当前编译环境进行调用的成员或字段的引用。 编译器检查到给定代码元素存在后,将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。

    有关如何创建对泛型类型的 cref 引用的信息,请参见 <see>(C# 编程指南)

  • description
    对成员的访问的说明。

备注

<permission> 标记使您得以将成员的访问记入文档。 使用 PermissionSet 类可以指定对成员的访问。

使用 /doc 进行编译可以将文档注释处理到文件中。

示例

// compile with: /doc:DocFileName.xml 

class TestClass
{
    /// <permission cref="System.Security.PermissionSet">Everyone can access this method.</permission>
    public static void Test()
    {
    }

    static void Main()
    {
    }
}

请参见

参考

建议的文档注释标记(C# 编程指南)

概念

C# 编程指南