Einzelnen Beitrag anzeigen

Benutzerbild von BUG
BUG

Registriert seit: 4. Dez 2003
Ort: Cottbus
2.094 Beiträge
 
#17

AW: Code Analyse von (semi) Profis

  Alt 2. Jun 2013, 15:00
Wie würde ein Kommentar bei dir aussehen, bei dem Du beschreibst, warum Du die Lösung so und nicht anders implementiert hast?
  1. Hinweise auf Entwurfsmuster
  2. Quellen und wichtige Eigenschaften der verwendeten Algorithmen
  3. Dokumentation von Sachen, deren Gründe sonst schlecht aus dem Code ersichtlich wären.
    (zB. Maßnahmen gegen das Auftreten von False Sharing)
  4. Gründe für Lösungen, wo man sich gegen das intuitive/kanonische Vorgehen entschieden hat.
    (zB. Dokumentation für Workarounds bei Fehlern in verwendeten Bibliotheken)

Natürlich kann einiges davon durch Verweise auf weitere Dokumentation ersetzt werden (z.B. im internen Wiki zum Projekt).
Intellekt ist das Verstehen von Wissen. Verstehen ist der wahre Pfad zu Einsicht. Einsicht ist der Schlüssel zu allem.

Geändert von BUG ( 2. Jun 2013 um 15:08 Uhr)
  Mit Zitat antworten Zitat