C# Xml documentations

C# надає змогу документувати код за допомогою XML.

Документація коду дає можливість стороннім розробникам які будуть використовувати ваш код отримати короткий опис функцій (їх параметрів, результуючих значень), властивостей, полів, класів, делегатів, інтерфейсів та будь яких користувацьких типів.

Розроблена вами документація буде відображатися в IntelliSense.


Всі інструкції які починаються з /// та знаходяться перед описом користувацького типу (чи члена класу) сприймаються компілятором як блок документації.

У блоці документації ви можете використовувати наступні XML теги:

• <param name='name'>description</param> (опис параметру методу)
• <returns>description</returns> (опис значення яке повертається з методу)
• <summary>description</summary> (опис об`єкту)
• <value>property-description</value> (опис властивості)
• ...

Детальніше про підтримувані теги можна почитати тут.

Приклад документації:

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>
    /// Here's how you could make a second paragraph in a description. 
    /// <see cref="System.Console.WriteLine(System.String)"/> 
    /// for information about output statements
    /// .</para>
    /// </summary>
    /// <param name="value">
    ///  This is our custom parameter
    /// </param>
    public static void DoWork(int value)
    {
    }
}

Детальніше про Xml документацію можна почитати на msdn:  http://msdn.microsoft.com/en-us/library/aa288481(v=vs.71).aspx