Sidebar
ein-/ausblenden

CSSDOC leicht gemacht

Plugin für WordPress SEO

Anzeige

CSSDOC logo

CSSDOC ist ein gemeinschaftliches Projekt und im aktuellen Adventskalender der Webkrauts ist der wunderbarere Artikel „Stylesheets kommentieren mit CSSDOC“ des Mitbegründers und YAML Erfinders Dirk Jesse veröffentlicht.

Die Idee von CSSDoc gefällt und da ich grundlegend im UltraEdit, meinem liebsten Editor, arbeite, habe ich mir die Tags in einer Tag-Liste hinterlegt, so dass ich schnell und einfach alle derzeit möglichen Tags zur Hand habe.

Screenshot UltraEdit und CSSDOC

Leider ist UltraEdit kein Open Source Projekt und alternativ kann man unter anderem Notepad++ und jEdit empfehlen. Beide sind auch erweiterbar und eventuell kann man dann die folgende Tagliste mit wenigen Veränderungen übernehmen. Zugreifen und CSSDOC im nächsten Projekt nutzen.
Nun fehlt mir nur noch die Integration im Parser CSSTidy, den ich auch in meinem Editor integriert habe, dann wäre das Validieren in meinem Editor auch für CSSDOC möglich.


[Tag Group - CSSDoc]
0="/**"
1="*"
2="*/"
3="Author :UEDS:* @author (file)"
4="Copyright :UEDS:* @copyright (file)"
5="Date :UEDS:* @date (file)"
6="Version :UEDS:* @version (file)"
7="Revision :UEDS:* @revision (file)"
8="Since :UEDS:* @since (file, section)"
9="License :UEDS:* @license (file)"
10="Link :UEDS:* @link (file)"
11="Lastmodified :UEDS:* @lastmodified (file)"
12="Media :UEDS:* @media (file, section)"
13="Site :UEDS:* @site (file)"
14="Style :UEDS:* @style (file)"
15="Appdef :UEDS:* @appdef (file)"
16="App :UEDS:* @app- (file; section)"
17="Colordef :UEDS:* @colordef (file; section)"
18="Note :UEDS:* @note (file, section, comment)"
19="Ref :UEDS:* @ref (section)"
20="Section :UEDS:* @section (section)"
21="See :UEDS:* @see (file, section)"
22="Tested :UEDS:* @tested (file, section, comment)"
23="ToDo :UEDS:* @todo (file, section, comment)"
24="Workaround :UEDS:* @workaround (section, comment)"
25="Bugfix :UEDS:* @bugfix (section, comment)"
26="Affected :UEDS:* @affected (section)"
27="CSS-for :UEDS:* @css-for (section)"
28="Valid :UEDS:* @valid (section)"
29=

4 Kommentare und 1 Trackback zu „CSSDOC leicht gemacht“

  1. 1
    Pingback von artnorm // CSSDOC im Dezember // simply perfect slim /// // /
  2. 2
    Kommentar von Dirk

    Hallo Frank,

    tolles Feedback zu CSSDOC. Vielen Dank dafür.

    Beste Grüße
    Dirk

  3. 3
    Kommentar von Frank Bültge

    Ich habe zu danken.
    Es wissen nicht viele Leute die Arbeit zu schätzen, vor allem wenn sie, wie bei dir und auch mir, ausschließlich in der Freizeit entsteht, neben Nicht-WWW-Hobbys und Familie.

    Alles Gute
    Frank

  4. 4
    Kommentar von Markus

    Interessantes Thema. Ich habe vor einigen Wochen den Technikwürze-Podcast zu diesem Thema schon sehr interessiert verfolgt. Ich denke, damit werde ich mich künftig auch mal etwas näher befassen.

  5. 5
    Kommentar von Ludwig

    Ein wirklich schöner Beitrag. Und danke für das Template. Ich nutze zwar auch UltraEdit, fahre aber seit geraumer Zeit mit dem phpDesigner weit mehr und effizienter. Ich werde mir nunmehr eine Lösung suchen, das von Dir eingebrachte Template in meine IDE zu integrieren. CSSDOC nutze ich seit einiger Zeit. Früher hatte ich mal Aptana genutzt und dort vom highresolution Blog die CSSDOC-Snippets integriert. Aber mit Aptana werde ich mittlerweile einfach nicht mehr warm. Daher brauche ich eine adäquate Lösung für die von mir genutzte IDE.

    Und CSSDOC sollte zum Standard werden. Gibt es doch seit einer Ewigkeit die Möglichkeit automatisiert Kommentare, respektive Dokumentationen von Java- (JavaDoc) und php-Projekten (phpDoc) zu erstellen. Ich hoffe, es gibt diese Möglichkeit eines Tages und ich hoffe, dass das automatisierte Verarbeiten der CSS Kommentare mit CSSTidy machbar wird.

    Danke und Grüße aus Braunschweig

Kommentar schreiben

Kommentarregeln: Bleib cool, kritisch ist in Ordnung, aber wenn du unhöflich bist, dann lösche ich deinen Kommentar. Bitte benutze deinen persönlichen Namen oder Initialen und nicht den Namen eines Unternehmens, dies würde als Spam gewertet und wird gelöscht. Der Zusammenhang zwischen Namen und URL sollte nicht offensichtlich auf Spam hindeuten! ♥ Ansonsten, vielen Dank für den Kommentar und viel Spaß mit meinem Blog.

E-Mail-Benachrichtigung bei weiteren Kommentaren.
Auch möglich: Abo ohne Kommentar.

Kommentar-Hilfe

händischer Spam:
Beachte die Kommentarregeln, jede Form von versuchtem Spam wird gelöscht. Warum und wieso steht in einem meiner Beiträge.

Bezug auf Textstellen:
Du kannst direkt bezug auf Textstellen im Beitrag nehmen. Dazu muss lediglich der Bereich im Artikel markiert werden; daraufhin erscheint ein Button, der den markierten Text in das Kommentarfeld übernimmt und als Zitat auszeichnet. Die Funktion ist nur bei aktivem JavaScript nutzbar.

xHTML:
Du kannst folgende Tags benutzen: <a href="" title=""> <abbr title=""> <acronym title=""> <blockquote cite=""> <code> <pre> <em> <strong> <strike> <ul> <ul> <li>

Achte darauf, wenn du Code im Kommentar hinterlegen willst, dann muss der Code maskiert sein. Dann wird er nicht interpretiert. Der Code muss mit Hilfe von HTML-Entities dargestellt werden, d.h. dass man z.B. < als &lt; und > als &gt; einfügt.

E-Mail-Benachrichtigung bei neuen Kommentaren ?
Wenn der Haken in der Checkbox gesetzt ist, dann wirst du über neue Kommentare vie E-Mail informiert. Der Versand erfolgt nur, wenn du die URL in der Bestätigungs-E-Mail genutzt hast oder schon Abonnent hier im Blog bist.

Kommentar erscheint nicht:
Alle Kommentare werden manuell geprüft, freigegeben und nach Möglichkeit beantwortet. Bitte um etwas Geduld und Nachsicht.

Identifikationsbilder (Avatare):
Auf Gravatar.com kann man sich mit seiner E-Mail-Adresse registrieren und ein Bild hochladen, dann erscheint dieses Gravatar hier und in vielen weiteren Blogs.

Spamschutz:
Das Kommentarformular ist mit einem Spamschutz ausgerüstet. Solltest du diesen Artikel ohne JavaScript besuchen und kommentieren wollen, so muss du die Frage beantworten und das jeweilige Wort in das Textfeld eingeben.