Summary doc tag and paramref tag : XML Documentation « Development Class « C# / C Sharp






Summary doc tag and paramref tag

 

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.  
    /// The <paramref name="Int1"/> parameter takes a number.
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

   
  








Related examples in the same category

1.set up project with one file containing the tag
2.Use summary element
3.XML Documentation: Compiler Support Tags
4.How to write the Xml based document
5.XML based comments
6.Summary doc tag, example doc tag
7.value doc tag
8.Use code tag to reference code
9.permission cref doc tag