Coding Conventions: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
| Zeile 235: | Zeile 235: | ||
==== Documentation Comments ==== | ==== Documentation Comments ==== | ||
Dieser XML ähnliche Kommentartype wird so Dokumentieren von Methoden, Properties und Klassen verwendet. Bei Visual Studio ist es ohne weiteres möglich diese Kommentare als XML Datei zu exportieren und als Schnitstellenbschreibung (API) oder sogar als vollständige Dokumentation auszubereiten. | Dieser XML ähnliche Kommentartype wird so Dokumentieren von Methoden, Properties und Klassen verwendet. Bei Visual Studio ist es ohne weiteres möglich diese Kommentare als XML Datei zu exportieren und als Schnitstellenbschreibung (API) oder sogar als vollständige Dokumentation auszubereiten. | ||
<source lang="csharp"> | |||
/// <summary> | |||
/// Baut einen String aus Vorname und Nachname | |||
/// </summary> | |||
/// <param name="name">Name</param> | |||
/// <param name="vorname">Vorname</param> | |||
/// <returns>String mit vollständigen Namen</returns> | |||
public string CreateNameString(string name, string vorname) | |||
{ | |||
String sname = String.Format("{0}, {1}", name, vorname); | |||
return sname; | |||
} | |||
</source> [[Kategorie:Code-Beispiele]] | |||
=== Coding Style === | === Coding Style === | ||
