Use summary element : XML Documentation « Development Class « C# / C Sharp






Use summary element

  
namespace SimpleXML
{
    /// <summary>
    /// Summary description for Class1.
    /// </summary>
    class Class1
    {
        /// <summary>
        /// The main entry point for the application.
        /// </summary>
        [STAThread]
        static void Main(string[] args) {}
   
        /// <summary>
        /// This method does something interesting.
        /// </summary>
        public static void Foo() {}
    }
}

   
  








Related examples in the same category

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