zurück zur Startseite
  


Zurück XHTMLforum > Sonstiges > Ressourcen
Seite neu laden CSSDOC - standardisierte CSS-Kommentare

Antwort
 
LinkBack Themen-Optionen Ansicht
  #1 (permalink)  
Alt 17.07.2007, 02:37
Benutzerbild von Pablo
4 8 15 16 23 42
XHTMLforum-Kenner
Thread-Ersteller
 
Registriert seit: 31.05.2004
Beiträge: 1.766
Pablo sorgt für eine eindrucksvolle AtmosphärePablo sorgt für eine eindrucksvolle AtmosphärePablo sorgt für eine eindrucksvolle AtmosphärePablo sorgt für eine eindrucksvolle AtmosphärePablo sorgt für eine eindrucksvolle Atmosphäre
Standard CSSDOC - standardisierte CSS-Kommentare

Hi,

Eine Gruppe von drei Leuten hat sich zusammengetan und möchte versuchen Kommentare in CSS-Dateien zu standardisieren.
Das ganze heißt CSSDOC und steckt noch in den Kinderschuhen, erste Entwürfe gibt es jedoch schon:
Schema soll ein aus anderen Sprachen bekanntes sein und lehnt sich an Javadoc an:
Code:
/**
 * Short Description
 *
 * Long Description
 *
 * @tag   I am a tag named "tag"
 * @other And I am a tag named "other"
 */
Vom Standard festgelegt wird, wo diese Blöcke ("DocBlock") einzusetzen sind und welche Tags für welche Bereiche es gibt.

Meiner Meinung nach ein ganz netter Ansatz, aber für CSS ein bisschen übertrieben.
Zwar ist diese Kommentarform sehr übersichtlich und wohlbekannt, aber es ist schon noch ein großer Unterschied, ob man ein Projekt von 100.000 Zeilen und 100 Dateien oder mehr kommentieren möchte, oder doch einfach nur ein oder zwei CSS-Dateien. Kompaktere Kommentare wären also sinnvoll und ob diese ganzen Tags wirklich gebraucht werden, oder einfach nur von den Entwickler mühsam aus der Nase gezogen wurden ist so leicht auch nicht zu beantworten.
Ein weiterer Kritikpunkt ist, dass Dateien auf Webseiten nach Möglichkeit so gut es geht komprimiert sein sollten. Und zwar nicht nur mit gzip, sondern auch durch entfernen von überflüssigen Kommentaren, zumindest in der öffentlichen Version (privat können und sollen natürlich Kommentare und White-Space gesetzt werden). Der Nutzen für die Öffentlichkeit (bzw. der interessierte Teil der Seiten-Besucher) tendiert also gegen null, der Vorteil für Entwickler kann sich erst in größeren Teams aufbauen. Für einen selbst kann man schließlich besser die eigene Kommentierweise verwenden und so einen noch besseren Überblick behalten.

Dennoch lobenswert, dass sich jemand um die CSS-Dateien kümmern möchte und vielleicht wird es ja in den nächsten Versionen noch massive Veränderungen geben.

[parallel auch auf meinem Blog veröffentlicht]

Gruß,
Pablo
__________________
Go Opera!
Mit Zitat antworten
Sponsored Links
  #2 (permalink)  
Alt 17.07.2007, 16:16
Benutzerbild von Artemis
Semantic Web Fanatic
XHTMLforum-Mitglied
 
Registriert seit: 21.01.2007
Beiträge: 107
Artemis befindet sich auf einem aufstrebenden Ast
Standard

Einer der drei Leute ist ja Dirk Jesse (YAML), und für YAML ist das ganze sehr vorteilhaft.
__________________
Applikations-Programmierung:
BlitzMax, BlitzPlus, C#

Webentwicklung:
PHP, HTML, XHTML, CSS, JavaScript, AJAX, MySQL, ASP
Mit Zitat antworten
Sponsored Links
  #3 (permalink)  
Alt 17.07.2007, 17:52
//
XHTMLforum-Kenner
 
Registriert seit: 19.12.2006
Ort: Gütersloh
Beiträge: 1.511
ArcVieh wird schon bald berühmt werdenArcVieh wird schon bald berühmt werden
Standard

Zitat:
Zitat von Artemis Beitrag anzeigen
Einer der drei Leute ist ja Dirk Jesse (YAML), und für YAML ist das ganze sehr vorteilhaft.
Für Webseite die Tutorials anbieten und oder von bekannten Designer, finde ich Kommentare auch sehr sinnvoll.
In der CSS von Molly E. Holzschlag findet man zum Beispiel auch einige Kommentare zu einzelnen vorgehensweisen.

Nur ob ein Kommentarblock als Einleitung für eine CSS Datei sinnvoll ist, ist wiederum eine andere Frage. Ich persönlich wüsste nicht was ich da schreiben sollte, bis auf Author, Ertstellungs- und Change Datum.
Mit Zitat antworten
  #4 (permalink)  
Alt 18.07.2007, 20:28
Benutzerbild von Geronimo
Erfahrener Benutzer
XHTMLforum-Kenner
 
Registriert seit: 14.06.2004
Beiträge: 2.625
Geronimo sorgt für eine eindrucksvolle AtmosphäreGeronimo sorgt für eine eindrucksvolle AtmosphäreGeronimo sorgt für eine eindrucksvolle AtmosphäreGeronimo sorgt für eine eindrucksvolle Atmosphäre
Standard

Irgendwie unsinnig. Kommentare haben in fertigen Dokumenten nichts zu suchen und als Gedankenstütze während der Entwicklung reicht locker eine Zeile.
Mit Zitat antworten
  #5 (permalink)  
Alt 27.07.2007, 20:29
Neuer Benutzer
neuer user
 
Registriert seit: 22.07.2007
Beiträge: 6
Robert S. befindet sich auf einem aufstrebenden Ast
Standard

Also erstmal finde ich die Idee sehr gut, natürlich lohnt sich das erst bei größeren Projekten, doch ich würde sie in der kurzen Schreibweise trotzdem nutzen.

Das Beispiel wie du es aufgeführt hast kam mir schon in YAML bekannt vor, und da würde ich nicht mehr von einem unsinnigen Projekt sprechen.

Bei zweisprachigen Projekten mit großen CSS-Dateien hilft das ungemein, wie man schön an der Original YAML-Basedatei sehen kann. Ohne diese Kommentare wäre die Einarbeitung in YAML sicher sehr schwer, womit man dann auch noch die Nützlichkeit in einem öffentlichen CMS beweisen könnte.
Mit Zitat antworten
Antwort

Themen-Optionen
Ansicht

Forumregeln
Es ist Ihnen nicht erlaubt, neue Themen zu verfassen.
Es ist Ihnen nicht erlaubt, auf Beiträge zu antworten.
Es ist Ihnen nicht erlaubt, Anhänge hochzuladen.
Es ist Ihnen nicht erlaubt, Ihre Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are an


Ähnliche Themen
Thema Autor Forum Antworten Letzter Beitrag
druckbare Bilder mit css einbinden rg69 CSS 1 21.02.2008 11:11
Lightbox mit zweiter CSS Datei funktioniert nicht T4ke CSS 12 11.12.2007 19:20
CSS und PHP bitkiller CSS 7 23.11.2005 23:36
Eric Meyer's CSS Petty Ressourcen 0 21.11.2005 08:18
Mozilla ignoriert externes css DarkWanderer CSS 9 22.09.2005 11:39


Alle Zeitangaben in WEZ +2. Es ist jetzt 02:39 Uhr.