Allgemeine Frage über HTML, CSS "Kommentare"
lima-city → Forum → Die eigene Homepage → HTML, CSS & Javascript
art
beispiel
bemerkung
bereich
code
datei
digitaler form
dokument
ende
grund
header
kommentar
mache
machen
mehrwert
mitgelieferten block
url
weglassen
zeichen
zweck
-
Hey!
Mich würde es mal brennden interessieren wie ihr die Kommentar in eure HTML und CSS Dokumente benutzt? Habe schon viele Arten gesehen aber welche Art macht ihr? Oder Benutzer ihr keine?
Also mein Aufbau ist immer so:
Ich mache zu jedem Bereich in HTML Dokument ein Kommentar.
Die Reihenfolge von Bereiche nehme ich auch im CSS Dokument als Kommentar.
Quasi ist der erste Bereich im HTML Dokument "Header" dann ist im CSS Dokument ebenfalls der erste Bereich "Header" dann "Body" etc.
So habe ich einen guten Überblick über meinem Code.
Wie macht ihr das? -
Diskutiere mit und stelle Fragen: Jetzt kostenlos anmelden!
lima-city: Gratis werbefreier Webspace für deine eigene Homepage
-
wenn es viele divs werden die ineinander verschachtelt sind mache ich ab und zu mal am Ende eines divs einen Kommentar welcher Bereich damit geschlossen wurde.
-
Wenn man an etwas größerem Arbeitet oder etwas im Team macht sollte man immer jeden "Codeblock" komentieren.
Also z.B. bei CSS
/*Login Kasten mittig*/ .middle { margin: -250px 0 0 -250px; position:absolute; top: 50%; left: 50%; width: 500px; height: 500px; }
Obwohl das ein schlechtes Beispiel ist da es auf einem Bibilen gerät nicht gut aussieht :)
Am besten schaust du dir einfach mal an wie leute die das können es machen.
Beispiel: Bootstap https://github.com/twbs/bootstrap/blob/master/less/navs.less -
Wenn ich Kommentare mache, dann sind die nur Serverseitig. Grund: jeder Kommentar, so wie auch jedes andere unnötige Zeichen (Whitespace usw) muss schließlich irgendwie zum Client übertragen werden und bringt ihm aber keinen Mehrwert, deshalb gleich weglassen. Außerdem geht auch niemanden etwas an, wo ich welche Bemerkung dazuklebe, die sind schließlich nur für mich gedacht.
Das einzige Mal wo wirklich Kommentare von mir am Client auftauchen ist hin und wieder in CSS-Dateien, wo ein Kommentar angibt, dass die folgenden Regeln z.B. für den Header, eine Loginseite, Formulare usw gedacht sind. Diese Kommentare tauchen aber auch nur dann am Client auf, wenn ich zu faul war das durch einen Minifier laufen zu lassen.
master4860 schrieb:
… was man ja auch an der Einrückungstiefe erkennen würde
wenn es viele divs werden die ineinander verschachtelt sind mache ich ab und zu mal am Ende eines divs einen Kommentar welcher Bereich damit geschlossen wurde. -
hackyourlife schrieb:
Naja... Die Codeformatierung bringt dem Nutzer auch nicht wirklich was, ist aber auch unnötiger Whitespace. Ich persönlich kommentiere, wo ich es für nötig halte, egal ob Server- oder Clientseitig und komprimiere die Clientseitigen Files im nachhinein.
Wenn ich Kommentare mache, dann sind die nur Serverseitig. Grund: jeder Kommentar, so wie auch jedes andere unnötige Zeichen (Whitespace usw) muss schließlich irgendwie zum Client übertragen werden und bringt ihm aber keinen Mehrwert, deshalb gleich weglassen.
Kommt halt immer drauf an, was für einen Zweck das ganze hat. Wenn das ein kleines Script für einen selbst ist, kann man das ganz weg lassen, wenn es später andere auch noch verstehen sollen können, schadet das sicher nicht. -
Viele Kommentare werden überflüssig, wenn man erstens HTML5 richtig einsetzt. Und wenn man dann noch die CSS Klassen oder CSS id richtig benennt sind Kommentare in HTML Dateien völlig überflüssig.
Oder was meint ihr wofür es die neuen Tags header, footer, article, nav und section gibt? -
Hey!
Ich mache es mithilfe dieses Gerätes: http://www.amazon.de/Livescribe-APX-00017-Pro-Smart-Stift/dp/B00FONJDZ6/ref=sr_1_1?ie=UTF8&qid=1432064359&sr=8-1&keywords=livescribe+3
Ich vermerke zu jedem wichtigen Programmteil eine Notiz im mitgelieferten Block (z.B. Welche Funktionen ein Button hat oder wohin er navigiert etc.). Man kann auch neue Gestaltungsideen für z.B. Grafische Oberflächen entwerfen.
Ich persönlich verwende diesen Stift auch sehr viel zum Modellieren, da man das Geschriebene in analoger und digitaler Form zur Verfügung hat. Mit der Gratis-App fürs Smartphone kann man es einfach und bequem auf den Computer speichern(z.B. mittels Evernote). Für mich sehr nützlich und ich finde es praktischer als herkömmliche Kommentare in den Codefiles.
Ich hoffe, ich konnte dir ein bisschen helfen und dir die Arbeit mit den Kommentaren vereinfachen.
Mit freundlichen Grüßen! -
Man sieht das es jeder auf seine Wiese macht.
Und keine Angst das oben waren nur Beispiele ;)
Aber echt gut zu wissen wie ihr es macht.
Hatbmich gefreut dasvihr so schnell beantwortet habt. Mal sehen wer sonst noch Auf einer anderen Art macht.
Fast vergessen. Ich mache logischerweise die WhiteSpaces auch raus. Verlängert unnötig die Lade Zeit.
Gruß -
Diskutiere mit und stelle Fragen: Jetzt kostenlos anmelden!
lima-city: Gratis werbefreier Webspace für deine eigene Homepage