Coding Conventions: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Keine Bearbeitungszusammenfassung |
|||
| Zeile 205: | Zeile 205: | ||
var test = 4 * 4 / (3 - 2 + | var test = 4 * 4 / (3 - 2 + | ||
1) + 8 * 1; | 1) + 8 * 1; | ||
</source> | </source> | ||
=== Kommentare === | |||
Dieser Abschnitt beschäftigt sich mit dem sinnvollen Kommentieren innerhalb des Source Codes. Kommentare sind ein wichtiger Bestandteil bei entwicklen von Projekten, sie diennen einmal zum Verständnis des Source Codes und zu anderen können sie eine Art Dokumentation sein. | |||
==== Single Line Comments ==== | |||
Dise Kommentare die nur eine Zeile lang sind werden mit // begonnen. Desweiteren wird // verwendet um Code auszukommentieren, hierfür gibt in den unterschiedlichen Entwicklungsumgebungen bereits eine Tastenkombination. (Visual Studio: Strg+E,C) | |||
<source lang="csharp"> | |||
//Do something | |||
//foo("expr1","expr2","expr3",expr4, | |||
// "expr5"); | |||
</source> | |||
==== Block Comments ==== | |||
Kommentare die über mehrere Zeile stehen zwischen /* Your Comment */ stehen. Diese sollte nur verwendet werden, um Code innerhalb eine Funktion oder eine Properties zu kommentieren. Für Beschreibung von gesamten Methoden, Properties oder Klassen sollte die Documentation Comments verwendet werden. | |||
<source lang="csharp"> | |||
/* I'am | |||
* a | |||
* comment | |||
*/ | |||
</source> | |||
==== Documentation Comments ==== | |||
Dieser Kommentartype wird so Dokumentieren von Methoden, Properties und Klassen verwendet. | |||
=== Coding Style === | === Coding Style === | ||
