Dokumentation: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
Dietsch (Diskussion | Beiträge)
Dietsch (Diskussion | Beiträge)
Zeile 50: Zeile 50:
Mit XML Kommentaren lässt sich zum Beispiel auch angeben, ob und wann [[Exception]]s auftreten können oder es lassen sich Querverweise zu anderen Stellen im Code definieren. <ref>http://msdn.microsoft.com/en-us/library/5ast78ax.aspx Microsoft MSDN - Recommended Tags for Documentation Comments (C# Programming Guide)</ref>
Mit XML Kommentaren lässt sich zum Beispiel auch angeben, ob und wann [[Exception]]s auftreten können oder es lassen sich Querverweise zu anderen Stellen im Code definieren. <ref>http://msdn.microsoft.com/en-us/library/5ast78ax.aspx Microsoft MSDN - Recommended Tags for Documentation Comments (C# Programming Guide)</ref>


Praktisch an XML Kommentaren ist, dass diese automatisch in einem Tooltip erscheinen, wenn die entsprechend dokumentierte Klasse, Funktion, etc. bei der Codeeingabe verwendet wird.
Praktisch an XML Kommentaren ist, dass diese automatisch in einem Tooltip erscheinen, wenn die entsprechend dokumentierte Klasse, Methode, etc. bei der Codeeingabe verwendet wird.


==== Aufgabenliste-Kommentare ====
==== Aufgabenliste-Kommentare ====