Benutzer-Werkzeuge
se:dokumentation
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
|
se:dokumentation [2009-01-30 14:21] stefan |
se:dokumentation [2014-04-05 11:42] (aktuell) |
||
|---|---|---|---|
| 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 \cite[S. 58ff.]{Goodliffe2006}** | ||
| * 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! | ||
| + | * {{:se:programmers-pyramid.png|}} | ||
| + | * (via [[http://osteele.com/archives/2008/01/programmers-pyramid]]) | ||
| * 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! | ||
| * Kommentare sind absolut unnütz (und sind evtl. falsch und veralten schnell), wenn sie lediglich den Code wiederholen. | * Kommentare sind absolut unnütz (und sind evtl. falsch und veralten schnell), wenn sie lediglich den Code wiederholen. | ||
| Zeile 21: | Zeile 23: | ||
| * 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 | ||
| + | |||
se/dokumentation.1233321682.txt.gz · Zuletzt geändert: 2014-04-05 11:42 (Externe Bearbeitung)
Seiten-Werkzeuge
Falls nicht anders bezeichnet, ist der Inhalt dieses Wikis unter der folgenden Lizenz veröffentlicht: CC Attribution-Noncommercial-Share Alike 4.0 International
