C# документация/комментарии для классов неизменяемого типа

Question

Привет, есть ли способ документировать свойства неизменяемого типа для разработчика в C#?

Я знаю, что вы можете легко документировать классы и объекты себя:

/// <summary> 
    /// This is an object 
    /// </summary> 

Но как я могу сделать запись для PopupMenu если я создаю новый объект:

Myobject ob1 = new Myobject(x1,x2,.....); 

Что бы например, есть краткое описание для каждого значения, например «x1 - это длина моего объекта», а «x2 - высота». Также я хотел бы добавить что-то отзывчивое, например, если пользователь дал «1» в качестве ввода для x1, x2 показывает всплывающую подсказку «Длина», но если пользователь дал вход «2», x2 показывает «высоту» в подсказка.

Answer 1

Над конструкторе добавьте это:

public class Myobject 
{ 
    /// <summary> 
    /// Initializes a new Myobject instance 
    /// </summary> 
    /// <param name="x1">The x1 parameter does something</param> 
    /// <param name="x2">The x2 parameter does another thing</param> 
    public Myobject(int x1, int x2) 
    {} 
} 

Для тегов документации более Availabe см this MSDN article