Documentation Comments for class : Documentation Comments « Language Basics « C# / CSharp Tutorial






using System;

namespace DocumentationCommentsExample
{
    /// <summary>
    /// A documentation sample - the short description goes here
    /// </summary>
    /// <remarks>Where a longer description would go</remarks>
    class ClassExample
    {
    }
}








1.2.Documentation Comments
1.2.1.Documentation Comments for class
1.2.2.Documentation Comments for A member variable
1.2.3.Documentation Comments for A property
1.2.4.Documentation Comments for a method with parameters
1.2.5.Documentation Comments for Main function
1.2.6.Compiler Support Tags
1.2.7.XML Documentation
1.2.8.Recommended Code Comment XML Elements