C# Dokumentation/Kommentare für unveränderliche Klassen

Question

Hallo, gibt es eine Möglichkeit, die Eigenschaften eines unveränderlichen Typs für einen Entwickler in C# zu dokumentieren?

Ich weiß, dass Sie leicht Klassen dokumentieren können und Objekte selbst mit:

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

Aber wie kann ich einen Eintrag für den popupmenu machen, wenn ich ein neues Objekt erstellen:

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

Was würde ich gerne haben Sie eine kurze Beschreibung für jeden Wert, zum Beispiel "x1 ist die Länge meines Objekts" und "x2 ist die Höhe". Ich möchte auch etwas Ansprechendes hinzufügen, zum Beispiel, wenn der Benutzer eine "1" als Eingabe für x1 gab, zeigt x2 den Tooltip "Länge", aber wenn der Benutzer eine "2" als Eingabe gab, zeigt x2 "Höhe" in der Tooltipp.

Answer 1

über Ihren Konstruktor fügen Sie diese:

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) 
    {} 
} 

Weitere verfügbare Dokumentation Tags sieht this MSDN article