Benutzer-Werkzeuge

Webseiten-Werkzeuge


se:dokumentation

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
se:dokumentation [2009-01-30 14:25]
stefan
se:dokumentation [2014-04-05 11:42] (aktuell)
Zeile 8: Zeile 8:
  
 ===== Quelltextdokumentation ===== ===== Quelltextdokumentation =====
-**nach ​{[quellen:​Goodliffe2008|S. 58ff.]}**+**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 23: Zeile 25:
     * die Gegenwart beschreiben und keine geänderten Codeteile dokumentieren -> dafür ist die [[Versionsverwaltung]] zuständig     * 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.1233321906.txt.gz · Zuletzt geändert: 2014-04-05 11:42 (Externe Bearbeitung)