Laden...
3 Antworten
1,669 Aufrufe
Letzter Beitrag: vor 16 Jahren
Hilfetext zu Methoden

Hallo!

Man kann ja zu Eigenschaften einen eigene Beschreibung, Kategorie usw. hinzufügen.

[Category("Eigene Eigenschaften")]
public TestEigenschaft
{
    get { ... }
    set { ... }
}

Kann man dies auch bei Methoden machen?
So das in der gelben Hilfebox der Text angezeigt wird.

Danke für eure Hilfe.

Hallo,

[Category("Eigene Eigenschaften")]

setzt den Text für das PropertyGrid. Für Beschreibungen der IntelliSense benutzt man


///<Summary>
///</Summary>

Gib einfach die drei Schrägstriche mit dem Wort Summary dahinter ein. VS fügt den Rest automatisch ein.

Gruß Olli

Man kann nicht nur die Methode an sich dokumentieren, sondern auch Parameter, Ausnahmen und den return-Wert.
Hier ein Beispiel einer Methode:

        /// <summary>
        /// Gibt die drei Parameter zusammengesetzt zurück.
        /// </summary>
        /// <param name="a">Parameter a</param>
        /// <param name="b">Parameter b</param>
        /// <param name="c">Parameter c</param>
        /// <returns>Die drei Parameter zu einem string zusammengesetzt</returns>
        /// <exception cref="ArgumentNullexception">
        /// Wenn Parameter a ein null-Wert ist
        /// </exception>
        string method(string a, int b, char c)
        {
            if (a == null) throw new ArgumentNullException();
            else return a + b + c;

Die Parameter und den return-Wert fügt VS automatisch hinzu, aber oft ist es ainvoll, auch die Ausnahmen anzugeben.
Weitere Angaben siehst du über Intellisense, wenn du ein "<" eintippst.