Documentation Comments for A property : Documentation Comments : Language Basics C# Examples

    
using  System;

namespace  DocumentationCommentsExample
{
        ///  <summary>
        ///  A  documentation  sample  -  the  short  description  goes  here
        ///  </summary>
        ///  <remarks>Where  a  longer  description  would  go</remarks>
        class  ClassExample
        {
                ///  <summary>
                ///  A  member  variable
                ///  </summary>
                private  string  m_str;


                ///  <summary>
                ///  A  property  example
                ///  </summary>
                ///  <remarks>
                ///  You  would  put  a  more  in  depth  description  inside  remarks  tags
                ///  </remarks>
                public  string  PropertyExample
                {
                        get
                        {
                                return  m_str;
                        }
                }

        }
}