24. November 2011

Kein Kommentar

24. November 2011 - Geschrieben von Martin - 4 Kommentare

Anfänger wird immer und überall eingebleut „Kommentiert alles“, „Schreibt viele Kommentare, damit auch andere euren Code verstehen“.

Sorry, aber das ist Schwachsinn! Wenn mein Code schon so schlimm ist, das ich kommentiere muss was ich mache, sollte ich lieber zurück an ans Papier und alles noch mal überdenken. Code kann sprechen. Code kann sich selbst erklären. Wer sagt denn, das ich „kryptische“ Funktionsnamen vergeben oder lauter Abkürzungen schreiben muss? Am Ende holt es mich doch eh wieder ein, denn

  • Code lesen ist ansträngender
  • Klassenexplorer nahezu sinnlos
  • ständig am Suchen der entsprechenden Funktionen und Methoden um nachzuvollziehen was gemacht wird
  • Einarbeiten in den Code nur möglich wenn man alle Kommentare liest und versteht!

Warum also

// erzeuge neues Fenster Objekt aus dem System Objekt s
$win = $s->cwin();

da schreibt man doch gescheiter

$window = $system->createNewWindow();

Wer nun noch sagt aber der Kommentar ist auf Deutsch den versteh ich wenigstens, dem kann ich nur sagen – falscher Job ;-)

Das ganze soll aber nicht heißen, das man gar nichts mehr Kommentieren sollte. Stellen, die etwas Tricky oder vielleicht noch nicht ganz ausgereift sind, können gern mit einem kurzen und knackigen Kommentar versehen werden, der das Anliegen gut rüberbringt.

4 Antworten zu “Kein Kommentar”

  1. Xugro sagt:

    Kein Kommentar

  2. roeluu sagt:

    Wir müssen in der Schule eine Website erstellen. Mit Konzept und so und wir sollten da eigentlich auch immer Kommentare verwenden. WAS LÄUFT HIER?! :D

    <!-- Dies ist der Kopfbereich -->
         askd
         <link href="style.css"..


    Das ist doch einfach nur lächerlich.

  3. Martin sagt:

    Oh mein Gott, so was ist doch ne Lachnummer. Also wenn ich das „head“ Tag nicht verstehe ist doch alles zu spät… ;-)

    Und was sagen deine Lehrer wenn du sagst Kommentare sind überflüssig?

    Irgendwie parst WordPress alles HTML aus Kommentaren heraus, mal schauen ob ich das irgendwie aushebeln kann.

  4. dthoelken sagt:

    Auf unserer Schule gibt es Lehrer, die sich Profi im Bereich „HTML, PHP und Java“ bezeichnen.

    Ich hatte zwei Freistunden und durfte eine Stunde miterleben.

    Beispiele: CSS wäre angeblich für die Schüler zu schwer und wäre nicht so wichtig, dass es im Unterricht beigebracht wird. Layouts werden mit Tabellen gemacht und alles wird schön kommentiert.

    Hätte ich die Wahl, wäre ich lieber in Hauswirtschaft, statt „Entwicklung“ gegangen.

    Liebe Grüße.

Schreibe einen Kommentar