Chuck Norris hat ein „Sie haben gewonnen“-Banner angeklickt. Und er hat gewonnen!

24.02.09

end main

Wenn man mit mehreren Leuten an einem Projekt arbeitet oder man später einen Nachfolger sucht, aber auch für sich selbst ist es immer hilfreich, seine Quelltexte richtig zu kommentieren. Dies gilt vor allem für echte Programmiersprachen, da es hier egal ist, wenn die Quelldatei ’mal ein paar Byte größer ist.

Im Web hat man ja üblicherweise immer mit lahmen Verbindungen zu kämpfen. Aber zum Glück sind die Zeiten des 56k Modems vorbei und ein paar Byte mehr kann jeder DSL Kunde verkraften.

Dieser einfache Trick ist nicht aufwendig, hat aber einen großen Effekt – vor allem, wenn man gerade keinen Editor mit Highlighting von Verschachtelungen zur Hand hat.

<body>
  <div id="main">
    <div id="header">
    </div><!-- end header -->
    <div id="content">
    </div><!-- end content -->
  </div><!-- end main -->
</body>

Ich habe es mir mittlerweile angewöhnt, hinter jeden größeren Div-Container einen kleinen Kommentar zu schreiben, der mir sagt, was denn hier genau zu Ende ist.

In diesem Beispiel mag es noch übertrieben aussehen. Aber es spart sehr viel Zeit, wenn noch einige Container dazwischengeschoben und womöglich sogar mit Blindtext gefüllt werden.

Kommentare [6]

Jonny Musikant am 26.02.2009 um 11:07

In manchen Unternehmen habe ich direkt mit Programmierern zu tun, die sich ausschliesslich per Kommentar “unterhalten”… da werden die von dir angesprichenen Kennzeichnungen teilweise um 10 Zeilen Programmiercode, Anweisungen und sogar Witze und anderes Gelaber ergänzt…

Markus am 26.02.2009 um 11:17

Naja, wie gesagt, etwas, das später durch den Compiler läuft, kann man gerne etwas ausführlicher kommentieren.

Im Web ist das mit der Geschwindigkeit nicht so prickelnd.

Nico am 1.03.2009 um 00:23

Ich denke ich werde es mir eh mal angewöhnen, es spart denke ich schon viel Zeit, sobald die Seite dann mal größer wird erspart das ganze auch nerven!

Dennis Frank am 18.03.2009 um 04:00

Ich schreib das immer so:

</div> <!— /.article —>

</div> <!— /#main —>

So erreicht man auch eine Unterscheidung zwischen Klasse und ID.

Markus am 18.03.2009 um 08:34

Hm, stimmt, das ist manchmal vielleicht ganz nützlich.
Allerdings wende ich das auch fast nur bei großen Divs mit ID an, da es bei übermäßigem Einsatz schnell ins Negative schwenken kann und es unübersichtlicher wird.

BajK am 7.09.2009 um 03:33

<?php /* Kommentar */ ?> so wird der ganze Murks nicht im endgültigen Quellcode an den “Endkunden” ausgeliefert :)
Geht ja kein Schwein was an, was ich da für Sachen reinschreibe :)

Kommentar verfassen

Textile-Hilfe

  • *stark*
  • _betont_
  • "Link":http://url.com/
  • bq. Zitatkasten
  • bc. Code-Block
Der Kommentar kann erst abgeschickt werden, wenn man mindestens einmal die Vorschaufunktion aktiviert hat.

Flattr

Blogrolle

Podroll

Soziale Netzwerke

Twitroll