Objekt-Tooltip Infos

TH3LL

Hi,
kann mir eventuell jemand verraten wie ich ein eine Funktion/Klasse etc deklarieren bzw. kommentieren muss, damit mir C# bei der verwendung im Programmcode genauere Informationen z.B. über die Parameter gibt?

Als Bsp erhält man beim ersten Parameter von System.Windows.Forms.MessageBox.Show ja die Info "text: Text der im Meldungsfeld angezeigt werden soll", usw...

Hab das zwar mal aus der Definition der MessageBox rauskopiert:

// Zusammenfassung:
        //     Zeigt ein Meldungsfeld mit angegebenem Text an.
        //
        // Parameter:
        //   text:
        //     Der im Meldungsfeld anzuzeigende Text.
        //
        // Rückgabewerte:
        //     Einer der System.Windows.Forms.DialogResult-Werte.
        public static DialogResult Show(string text);
        //...

, funktioniert bei mir aber nicht ---
hmmm...

Konrad Rudolph

Du musst XmlDoc-Kommentare verwenden. Gib einfach mal im Editor vor einer Funktion drei Slashes '///' ein, dann erledigt der Editor den Rest für Dich. Das sieht dann z.B. so aus:

/// <summary>
/// Determines the maximum of two numbers.
/// </summary>
/// <param name="a">The first number.</param>
/// <param name="b">The second number.</param>
/// <returns>Returns the maximum.</returns>
public int max(int a, int b) {
    return a > b ? a : b;
}

TH3LL

Wir programmieren zur zeit was im Team, da wäre es ganz gut im Endeffekt zu wissen womit man die Funktionen des anderen denn nun füttern soll

Vielen dank

In dem Zusammenhang kann man auch folgendes benutzen:

enum test
    {
        /// <summary>
        /// Ein sinnloser Kommentar
        /// </summary>
        Parameter,
        /// <summary>
        /// Die Strecke zwischen zwei Photos einer Diashow
        /// </summary>
        Diameter
    }

Geht man dann mit Intellisense durch die Liste der enums werden die KOmmentare automatisch als Tooltip angezeigt.

TH3LL

coole sache!
danke