Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I document a c# dll

How do I write a class so that property and method descriptions are visible to people referencing the dll in other projects?

    [Description("My age in years attribute")]
    public int Age
    {
        get { return 0; }
        set { }
    }

doesn't work, neither does

    /// <summary>
    /// My age in years attribute
    /// </summary>
    public int Age
    {
        get { return 0; }
        set { }
    }
like image 344
James Avatar asked Feb 03 '10 15:02

James


1 Answers

In Visual Studio:

Project -> Properties -> Build -> Check "XML Documentation File".

For further details, see XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files.

like image 67
jason Avatar answered Sep 19 '22 06:09

jason