Share via

<permission> (C# Programming Guide)

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

Parameters

  • cref = " member"
    A reference to a member or field that is available to be called from the current compilation environment. The compiler checks that the given code element exists and translates member to the canonical element name in the output XML. member must appear within double quotation marks (" ").

    For information on how to create a cref reference to a generic type, see <see> (C# Programming Guide).

  • description
    A description of the access to the member.

Remarks

The <permission> tag lets you document the access of a member. The PermissionSet class lets you specify access to a member.

Compile with /doc to process documentation comments to a file.

Example

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

See Also

Concepts

C# Programming Guide

Reference

Recommended Tags for Documentation Comments (C# Programming Guide)