Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Jeremi (Diskussion | Beiträge) |
Jeremi (Diskussion | Beiträge) |
||
| Zeile 69: | Zeile 69: | ||
== Wie kommentieren? == | == Wie kommentieren? == | ||
... | === Innerhalb von Prozeduren, Methoden, Funktionen === | ||
Nach den [[CleanCode|Clean Code Prinzip]] sollte ein Programm sich selbst beschreiben und mit möglichst wenigen Kommentaren auskommen<ref>http://www.clean-code-developer.de/Source-Code-Konventionen.ashx Clean Code Developer - Source Code Konventionen</ref>: | |||
Statt: | |||
<source lang="csharp"> | |||
int length = 210; // Länge in mm | |||
</source> | |||
Besser: | |||
<source lang="csharp"> | |||
int length_in_mm = 210; | |||
</source> | |||
Statt: | |||
<source lang="csharp"> | |||
public Vector3D Position() { | |||
// Calculates new Position | |||
} | |||
</source> | |||
Besser: | |||
<source lang="csharp"> | |||
public Vector3D CalculateNewPosition() { | |||
... | |||
} | |||
</source> | |||
=== Klassen, Methoden === | |||
Klassen Methoden, Prozeduren, Funktionen, etc. sollten mit [[Dokumentation#XML_Kommentare|XML Kommentaren]] versehen werden. Diese werden verwendet um die automatisierte Dokumentation zu bauen. | |||
Außerdem werden XML Kommentare dazu verwendet, bei der Codeeingabe Hinweise in einer Tooltip Box anzuzeigen, so dass das arbeiten mit dokumentierten Funktionen deutlich leichter fällt. [[Kategorie:Code-Beispiele]] | |||
== Wie man NICHT kommentieren sollte == | == Wie man NICHT kommentieren sollte == | ||
