Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung | Nächste Überarbeitung Beide Seiten der Revision | ||
se:dokumentation [2009-01-30 14:21] stefan |
se:dokumentation [2009-01-30 14:25] stefan |
||
---|---|---|---|
Zeile 6: | Zeile 6: | ||
* **Schreibe Code, der nicht dokumentiert werden muss!** | * **Schreibe Code, der nicht dokumentiert werden muss!** | ||
* Programmier**sprachen** sind das Kommunikationsmedium der Entwickler -> sprechenden Code schreiben. | * Programmier**sprachen** sind das Kommunikationsmedium der Entwickler -> sprechenden Code schreiben. | ||
- | * siehe auch [[Versionsverwaltung]] | ||
===== Quelltextdokumentation ===== | ===== Quelltextdokumentation ===== | ||
+ | **nach {[quellen:Goodliffe2008|S. 58ff.]}** | ||
* Code wird (deutlich) häufiger gelesen als geschrieben, also schreibe verständlichen Code und kommentiere sinnvoll! | * Code wird (deutlich) häufiger gelesen als geschrieben, also schreibe verständlichen Code und kommentiere sinnvoll! | ||
* Schreibe nur Kommentare, wenn es keine bessere Möglichkeit gibt, den Code verständlicher zu machen! | * Schreibe nur Kommentare, wenn es keine bessere Möglichkeit gibt, den Code verständlicher zu machen! | ||
Zeile 21: | Zeile 21: | ||
* keine Witzchen oder Wortspiele einbauen | * keine Witzchen oder Wortspiele einbauen | ||
* so exakt wie möglich ausdrücken | * so exakt wie möglich ausdrücken | ||
+ | * die Gegenwart beschreiben und keine geänderten Codeteile dokumentieren -> dafür ist die [[Versionsverwaltung]] zuständig | ||
* verständliche Sprache und korrekte Rechtschreibung und Grammatik verwenden | * verständliche Sprache und korrekte Rechtschreibung und Grammatik verwenden |