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, 03:37
Benutzerbild von Pablo
4 8 15 16 23 42
XHTMLforum-Kenner
Thread-Ersteller
 
Registriert seit: 31.05.2004
Beiträge: 1.772
Pablo 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!
… oder Chrome. Auch cool.
Mit Zitat antworten
Sponsored Links
  #2 (permalink)  
Alt 17.07.2007, 17:16
Erfahrener Benutzer
XHTMLforum-Mitglied
 
Registriert seit: 21.01.2007
Beiträge: 106
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.
Mit Zitat antworten
Sponsored Links
  #3 (permalink)  
Alt 17.07.2007, 18:52
Benutzerbild von ArcVieh
//
XHTMLforum-Kenner
 
Registriert seit: 19.12.2006
Ort: Gütersloh
Beiträge: 1.844
ArcVieh sorgt für eine eindrucksvolle AtmosphäreArcVieh sorgt für eine eindrucksvolle Atmosphäre
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, 21:28
Benutzerbild von Geronimo
Erfahrener Benutzer
XHTMLforum-Kenner
 
Registriert seit: 14.06.2004
Beiträge: 2.641
Geronimo 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, 21: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
  #6 (permalink)  
Alt 19.05.2011, 21:08
a3e a3e ist offline
Neuer Benutzer
neuer user
 
Registriert seit: 06.05.2011
Beiträge: 25
a3e zeigte ein beschämendes Verhalten in der Vergangenheit
Standard

irgendwie vertsehe ich das ganze nicht um die Dokumentation und auch Yaml.

Vielleicht bin ich ja noch zu jung in dieser Richtung (Hobbie-Webdesigner seit einem halben Jahr), aber wie schon Geronimo sagt haben auch meiner meinung nach Kommentare in fertigen bzw. veröffentlichten Projekten nichts zu suchen (was mich auch schon seit längerem aufregt ist diese "Semantischer Code" und damit NUR zum Ausdruck bringen "schreibt euern Code so, das ich es auch nachvollziehen und nachahmen / mir kopieren kann ohne selbst etwas lernen / ausdenken muss... ")....

Vielleicht sind meine Projekte / Arbeiten noch nicht groß genug (größtes projekt hat aktuell in CSS knapp 2.800 zeilen), aber ich komm eindeutig mit meinen auf 3 bis 4 Buchstaben abkürzungen und visueller /*****/ zeile als Trennung zwischen wichtigen bzw. unterschiedlichen Ereignissen super klar.

Und sobald eine Arbeit fertig ist, wird alles wieder entfernt (sogar leerzeilen) und jetzt kommts - WARUM MUSS ICH MIR ANHÖREN dass ich ein "Noob" wäre, nur weil die Person etwas nachvollziehen will wie ich es gemacht habe, aber sich nicht wirklich zurecht findet in meinem Code ?!?!

Sorry, aber genau das ist ja auch der Sinn, da ich ansonsten auch 0 8 15 machen bzw. fertige zeilen, js, php-scripte etc. einfach runterladen könnte.


Webdesign - ..design.. sollte soweit es möglich ist absolut individuell und einzigartig sein - ich mein, dafür zahlen ja auch die Leute, wenn sie zu einem Webdesigner gehen und nicht sich standards gestalten ala 1&1, GoLive usw. Fertig-Baukasten usw.


Ich als Hobbie-Webdesigner möchte meinen Kunden Webseiten bieten mit eindeutigem Wiedererkennungswert und im besten Fall für eine lange zeit. Und wenn es sein muß, arbeite ich mit halbtransparenten kennzeichnungen, grafiküberlagerungen, rechtsclick-sperren (auf verschiedensten arten) usw. - und ja, ich weiss das man alles umgehen kann und man alles rankommt da es ja im Browser...... aber es ist ab einer bestimmten Zeit und viel Anstrennung nicht mehr die Arbeit wert irgendwann, wenn das zu aufwendig wird, geben die meisten doch dann auf und die die das alles ganz schnell umgehen, durchblicken können, sind Könner und Profis und die haben das nicht nötig. Ergo: Code und Grafiken sind einigermaßen (zumindest) vor leien geschützt.



ups - sorry, ich merk gerade das ich mich gerade hier abreagiert und mal bischen ausgek... habe, sorry sorry, aber dennoch lass ich es jetzt drinn - muss ja auch mal gesagt werden :P

Geändert von a3e (19.05.2011 um 21:17 Uhr)
Mit Zitat antworten
  #7 (permalink)  
Alt 19.05.2011, 23:01
Benutzerbild von Scheppertreiber
Chaot und Nonkonformist.
XHTMLforum-Kenner
 
Registriert seit: 13.03.2007
Ort: Steinmark im Spessart
Beiträge: 7.458
Scheppertreiber ist ein LichtblickScheppertreiber ist ein LichtblickScheppertreiber ist ein LichtblickScheppertreiber ist ein LichtblickScheppertreiber ist ein Lichtblick
Standard

Keine Panik, ist ok

Alternative: Im CSS die Kommentare per ';' in der ersten Spalte kennzeichen
und per make und einem geeigneten Programm rauswerfen. Du hast deine Kommentare
und sonst niemand. Sie sind ja auch nur für Dich.

Nebenbei ist das Problem so etwa 4 Jahre alt. Aber aktuell ...

Grüße Joe
__________________
Grüße aus dem Spessart, Joe

{ table-layout: biertischistbesser; }
Der Mausinator
Mit Zitat antworten
  #8 (permalink)  
Alt 19.05.2011, 23:29
a3e a3e ist offline
Neuer Benutzer
neuer user
 
Registriert seit: 06.05.2011
Beiträge: 25
a3e zeigte ein beschämendes Verhalten in der Vergangenheit
Standard

Das ist nett dass ich keine Panik schieben muss


Es is keine Panik sondern Genervtheit von der ganzen ..semantik hier..semntik da... bla bla bla!

Ja, ich habe es nach dem abspeichern auch gesehen, dass es ein 4 jahre alter thread bzw. thema ist, aber immer noch bzw. dennoch aktuell.

Das mit den Kommentaren, das es nur für mich sei usw. ist ja nicht das Problem, sondern eher wie der CSS-Code aufgebaut ist (laut dieser "Profis") und da krieg ich einen Hals - 1. wenn das auf den Monitoren erscheint was man will und nur das was man will und 2. wenn alles genauso angezeigt wird wie man will aber absichtlich verwirrung im Code und nur im Code schafft, ist das absolut Sinnig und wenn es das Ziel ist, dann ist es auch richtig.

Das wollt ich nur sagen und das mit den Kommentaren war nur nebenbei bemerkt, dass da nicht so ein Wind drum gemacht werden sollte - jeder selbst muss entscheiden und es nicht halb so viel Wert darüber zu diskutieren - da ist es eher störender die Geschichte mit Semantik usw. da man auch immer wieder darauf stößt - in derartigen Foren vorallem -

Beispiel:

man hat eine kleine Frage wegen einer Kleinigkeit bzw. Anliegen zB. wie man position:absolut; in den verschiedenen Borwsern gleichermaßen angehen kann (nur blödes beispiel) und man stellt ein paar zeilen Code zur Veranschauung, es kommen tausende super möchtegernschlaue sprüche, dass man hier und da mit tabulator einrücken soll und oder die geschweiften Klammern an einer anderer stelle setzen soll oder mein favorit: warum willst du denn das machen usw?

Und egal wie man Antwortet, hat man seinen eigenen Kopf und man ist neu in der jeweiligen Umgebung (sei es spezielle Foren-Seiten, Mirc, xchat usw.), gibt es gleich ein bündniss dieser super-ego-ichbineinprofi-möchtegern-checker .......... - *würg* - *kotz*


puuh - das tut ja mal richtig gut, das alles mal rauszulassen - ich sollte als nächstes ein eigenen Forum machen und Thema Nr. wird sein "nieder den spacko-kerneln" oder so ähnlich
Mit Zitat antworten
  #9 (permalink)  
Alt 19.05.2011, 23:37
Benutzerbild von Scheppertreiber
Chaot und Nonkonformist.
XHTMLforum-Kenner
 
Registriert seit: 13.03.2007
Ort: Steinmark im Spessart
Beiträge: 7.458
Scheppertreiber ist ein LichtblickScheppertreiber ist ein LichtblickScheppertreiber ist ein LichtblickScheppertreiber ist ein LichtblickScheppertreiber ist ein Lichtblick
Standard

Der heilige Gral ...

Klar. Es gibt immer die "reine Lehre" und dann die "Anwendung". HTML/CSS
geben ja nur eine Menge Steuerbefehle zur Hand ums den Leuten möglichst
einfach zu machen.

Das Ergebnis ist dann so oder halt anders.

Das mit dem "semantisch" habe ich dann halt mal gemacht weil's hier "in" ist,
die Resultate waren frappierend. Ich baue größere Archivsysteme für den Bereich
Pharmagroßhandel - ohne Tabellen und so einen Schlonz werden die Seiten immer
kleiner (-70% im Schnitt), stabiler und leichter zu pflegen (validiert = minimalste
Unterschiede mit den IEs). Es lohnt sich wirklich ... Ernsthaft.

Grüße Joe.

PS: Und dann wirf das PHP raus und es wird sogar schnell mit C
__________________
Grüße aus dem Spessart, Joe

{ table-layout: biertischistbesser; }
Der Mausinator
Mit Zitat antworten
Sponsored Links
  #10 (permalink)  
Alt 20.05.2011, 00:00
a3e a3e ist offline
Neuer Benutzer
neuer user
 
Registriert seit: 06.05.2011
Beiträge: 25
a3e zeigte ein beschämendes Verhalten in der Vergangenheit
Standard

Ja ne is klar ne

Ich bin auch kein Fan von Tabellen - da marg ich lieber divs.

Was IE betrifft, es nervt einfach nur, aber MS hat ja sein Monopol (Linux, Unix und auch Mac kommen dagegen nicht an) und solang das der Fall ist, wird es der meistbenutzte Browser sein und wir müssen alles auch dem gerecht machen - aber da regt mich Safari und Chrome im Moment mehr auf (Beispiel thmea linehight).

Und was Validierung betrifft, bei mir gibt es immer den einen Fehler, der aber mir auch wirklich nichts ausmacht, im gegenteil - lieber habe ich den "Fehler" als diese blöde und die Optik störende textarea größenänderung.

Ich hab schon gehört wie leute über Java abkotzen weil es so langsam sei, aber ich lese zum ersten mal C kontra PHP - aber warum nicht.
Leider bin ich noch nicht soweit für C (außer die schlichtesten Anwendungen), aber ich musste mich erst zu PHP statt Perl entschliessen und das auch nur weil PHP wirklich stetig am wachsen ist und Perl anscheinend immer mehr untergeht / in vergessenheit....

Es hört sich ja so an als wärst du richtig fittt was Datenbanken usw betrifft kann das sein?
Mit Zitat antworten
Sponsored Links
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 aus


Ähnliche Themen
Thema Autor Forum Antworten Letzter Beitrag
Einbindung von frei erhältlichen Scripten - CSS Problem DonL CSS 1 22.01.2011 17:09
2 CSS Files -> 1 CSS File Habi CSS 7 17.02.2010 16:25
MYspace mehr als nur CSS oder ? Vinceone CSS 0 12.07.2007 03:21
Eric Meyer's CSS Petty Ressourcen 0 21.11.2005 09:18
Mozilla ignoriert externes css DarkWanderer CSS 9 22.09.2005 12:39


Alle Zeitangaben in WEZ +2. Es ist jetzt 22:14 Uhr.