wabis

 Profile Answers by wabis 

• Mar 25th, 2008

 

<summary> tag.

usage :

/// <summary>

/// string usage array class.

/// </summary>

public class teststring

{

public string s;

}

when we create the object for teststring class or browse through the class explorer through intellisense we can see this documented information.

PeterVH

• Aug 19th, 2011

 

Don't forget Microsoft Sandcastle, which extracts a very nice document to go along with your code.. In theory one can use a huge number of tags, but the sourcefile can become unreadable then. In that case, put the comments in a seperate file and use the tag to get the comments linked to the member.

Code
        /// <summary>


        /// This function <c>FooBar</c> is just to test the triple-slashes.


        /// If doesn't really seem to do something..


        /// </summary>


        /// <param name="banana">The banana suplied of type <see cref="Class1"> Class1 </see> </param>


        /// <exception cref="ArgumentNullException"><paramref name="banana" /> is <c>null</c>.</exception>


        /// <example>If you are wondering what to do with the possible exception, I suggest this:


        /// <code>


        /// try


        /// {


        ///     FooBar(new Class1(5));


        /// }


        /// catch (Exception e)


        /// {


        ///     LogException(e);


        /// }


        /// </code>


        /// </example>


        /// <returns>Zhe number of ze beast</returns>


        public int FooBar(Class1 banana)


        {


            if(banana == null)


                throw new ArgumentNullException("banana", @"banana is null!");


 


            //do stuff..


            return 666;


        }