Dokumentation: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
Jeremi (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
Jeremi (Diskussion | Beiträge)
Zeile 32: Zeile 32:


=== XML Kommentare ===
=== XML Kommentare ===
...
Mit XML Kommentaren können Klassen, Methoden, Eigenschaften, etc. zusätzliche Meta Informationen mitgegeben werden, um die Dokumentation des Codes zu erleichtern. Gibt man in Visual Studio vor einer bereits deklarierten Prozedur das dritte Slash ein, so werden anhand der Signatur der Funktion automatisch die notwendigen XML Tags erstellt.
 
<source lang="csharp">
/// <summary>
/// Calculates length of the hypotenuse in a right-angled triangle.
/// (Pythagorean theorem)
/// </summary>
/// <param name="a">length of first leg</param>
/// <param name="b">length of second leg</param>
/// <returns>length of hypotenuse</returns>
public double GetHypotenuse(double a, double b)
{
    return Math.Sqrt(Math.Pow(a, 2) + Math.Pow(b, 2));
}
</source> [[Kategorie:Code-Beispiele]]


=== Task Listen Kommentare ===
=== Task Listen Kommentare ===