Klein-Dummy: Wieviel kommentiert ihr?

Hallo,

wieviel kommentiert ihr, wenn ihr Webseiten entwickelt?
Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
Woran liegt das?

Viele Grüße

  1. Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
    Woran liegt das?

    weil die meisten leute mit wysiwyg-editoren arbeiten oder aber so schlau sind und die serverseitige scriptsprache kommentieren

    siehe folgendes

      
    <!-- jetzt kommt eine überschrift -->  
    <h1>Überschrift</h1>  
    
    

    und folgendes

      
    <?php /* jetzt kommt eine überschrift */ ?>  
    <h1>Überschrift</h1>  
    
    

    von zweiterem beispiel hat der entwickler genausoviel, die daten werden aber nicht unnötigerweise zum client übertragen

  2. Hi!

    wieviel kommentiert ihr, wenn ihr Webseiten entwickelt?

    Reines HTML und CSS? Wenig bis gar nicht!

    Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
    Woran liegt das?

    Daran, dass ein Webdokument keine Anwendung ist.

    --
    "You know that place between sleep and awake, the place where you can still remember dreaming?" (Tinkerbell)
  3. Hallo,

    Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
    Woran liegt das?

    Meinst Du HTML-Kommentare? Die werden schließlich alle bei jedem Seitenaufruf an den Benutzer übertragen und verursachen Traffic und längere Ladezeiten. Außerdem ist HTML keine Programmiersprache und es sollte deshalb auch nicht viel zu kommentieren geben.

    Alex

  4. Hi,

    wieviel kommentiert ihr, wenn ihr Webseiten entwickelt?

    HTML wird nur dokumentiert - es besteht a) aus einem (ggf. generischen) Gerüst und b) aus modularen Komponenten. Kommentare sind nicht nötig, außer vielleicht während der Entwicklungsphase, um die erzeugenden Programmteile und Dateien identifizieren zu können. Ausnahme mögen Code-Teile sein, in denen Whitespaces durch Kommentare eliminiert werden (besonders um Meinen Selten Intelligenten Erzfeind (MSIE) zu einem halbwegs brauchbaren Verhalten zu bewegen).

    CSS wird auch kommentiert. Hier gibt es nicht nur den modularen Aufbau, sondern immer wieder Begründungen, warum eine bestimmte Eigenschaft unter bestimmten Bedingungen in einem bestimmten Browser einen bestimmten Wert annehmen muss. Ferner lassen die Selektoren oft nicht sofort den Schluss zu, welche Elemente nun alles betroffen sind. Und dass jedes einzelne !important schriftlich gerechtfertigt zu werden hat ist ohnehin klar.

    Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
    Woran liegt das?

    Die Zielgruppe, die den Code erhält, sind Nutzer, keine Entwickler. Von einem Webserver ausgelieferter Code braucht schlussendlich keinen einzigen Kommentar mehr zu besitzen.

    Cheatah

    --
    X-Self-Code: sh:( fo:} ch:~ rl:° br:> n4:& ie:% mo:) va:) de:] zu:) fl:{ ss:) ls:~ js:|
    X-Self-Code-Url: http://emmanuel.dammerer.at/selfcode.html
    X-Will-Answer-Email: No
    X-Please-Search-Archive-First: Absolutely Yes
  5. Hallo

    wieviel kommentiert ihr, wenn ihr Webseiten entwickelt?

    Wenig. Ich unterscheide da auch nicht zwischen einer HTML-Seite und einem Programm wie einige andere hier im Thread. Allerdings sind die Strukturen eines HTML-Dokuments in weiten Teilen selbsterklärend, gerade, wenn Blöcke mit IDs und/oder Klassen versehen sind. Im Normalfall werden von mir nur die Endpunkte von Blöcken markiert, damit sie in einem größeren Dokument mit verschachtelten Strukturen schnell auffindbar sind.

    <div id="all">  
     <div id="navigation">  
      <!-- Inhalt der Navigation, der im Original nicht kommentiert ist. -->  
     </div><!-- Ende: #navigation-->  
     <div id="content">  
      <!-- Ganz viel Nutzinhalt der Seite, der im Original nicht kommentiert ist. -->  
     </div><!-- Ende: #content -->  
    </div><!-- Ende: #all -->
    

    Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
    Woran liegt das?

    Wie gesagt, meist ist der Aufbau selbsterklärend.

    Tschö, Auge

    --
    Die deutschen Interessen werden am Liechtenstein verteidigt.
    Veranstaltungsdatenbank Vdb 0.2
  6. Mahlzeit Klein-Dummy,

    wieviel kommentiert ihr, wenn ihr Webseiten entwickelt?

    Zu wenig ... VIEL zu wenig.

    Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
    Woran liegt das?

    Weil es sich ja "nur um ein bisschen HTML" handelt ... und "die paar Codezeilen" kann man ja noch in ein paar Monaten verstehen. Bis dann noch ein paar dazukommen. Und dann noch ein paar.

    Webseiten bzw. -"anwendungen" sind IMHO einem viel stärkeren und dynamischeren Wandel ausgesetzt als klassische Desktop-Anwendungen. Deswegen wird bei den vielen kleinen Änderungen vielleicht weniger darauf geachtet?

    MfG,
    EKKi

    --
    sh:( fo:| ch:? rl:( br:> n4:~ ie:% mo:} va:) de:] zu:) fl:{ ss:) ls:& js:|
  7. Salvete,

    also HTML und CSS geringfuegig.
    Bei PHP halte ich mich tatsaechlich an die Standarddokumentation.
    Das ist zum einen noetig, wenn irgendwann ein anderer mit deinem
    Quelltext arbeiten muss, und zum anderen laesst sich somit recht
    gut eine API generieren. Abgesehen davon halte ich es auch einfach
    fuer einen guten Stil, seinen Code zu dokumentieren.

    MfG,
    Sympatisant

    --
    "Non dura iubeantur, non prohibeantur inpura."
  8. Hallo,

    Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
    Woran liegt das?

    Das liegt daran, dass der Inhalt schon beschreibt, worum es geht ;-)

    Hotte

  9. Sabaai-dii!

    wieviel kommentiert ihr, wenn ihr Webseiten entwickelt?
    Ich habe den Eindruck, dass Webseiten - im Gegensatz zu anderen Anwendungen - extrem wenig Kommentare enthalten.
    Woran liegt das?

    (X)HTML kommentiere ich so gut wie gar nicht. Ordentliches Einrücken in Verbindung mit sinnvollen IDs und Klassen reicht normalerweise aus, um selbsterklärenden Quelltext zu erzeugen. Selbst die oft gesehenen Bereichsbezeichnungen wie z.B. <!-- footer --> spare ich mir fast immer, denn <div id="footer"> beschreibt das IMHO genausogut. Dank Einrückung und Syntax-Highlighting finde ich auch den zugehörigen Endtag schneller als einen eventuellen Footer-Ende-Kommentar.
    Höchstens manche unsichtbaren Elemente oder ulkige Workarounds (meistens für den IE) brauchen manchmal eine Kennzeichnung ihres Zwecks.
    In CSS verwende ich des öfteren solche Bereichsbezeichnungen, da es da ja keine verschachtelten Strukturen gibt.

    In allen anderen Sprachen bemühe ich mich, möglichst ausführlich zu kommentieren (kommt leider manchmal zu kurz, wenn nicht viel Zeit zur Verfügung steht). Aber auch hier spare ich mir Kommentare, die keine Zusatzinfos bringen, also v.a. Übersetzungen meiner (grundsätzlich englischen) Variablennamen. Kommentare wie
    String userName; //Benutzername
    oder
    if (!loggedIn) { //wenn nicht eingeloggt
    sind IMHO sinnlos.
    Wichtige Kommentare sind Beschreibungen, was Funktionen und Code-Abschnitte im großen und ganzen tun, und Erklärungen von wirren Ausdrücken mit ternärem Operator, Bitshifts usw.
    Auch reguläre Ausdrücke werden gerne schwer lesbar, so daß man unbedingt dazuschreiben sollte, was genau da gematcht wird.

    Viele Grüße vom Længlich

    --
    Mein aktueller Gruß ist:
    Lao (gesprochen in Laos)