Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
| 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 | 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 drei Slashes (<code>/</code>) ein, so werden anhand der Signatur der Funktion automatisch die notwendigen XML Tags erstellt. | ||
<source lang="csharp"> | <source lang="csharp"> | ||
| Zeile 48: | Zeile 48: | ||
</source> [[Kategorie:Code-Beispiele]] | </source> [[Kategorie:Code-Beispiele]] | ||
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 | 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, Funktion, etc. bei der Codeeingabe verwendet wird. | ||
