CSSDOC Draft

Status of this Document

The Second Public Draft is available since November 2008. The Spec is still in the process being written aber we are getting closer to the first specification. Please keep in mind, that the draft is subject to change.

• CSSDOC Second Public Draft PDF-File (2008-11-16)
• CSSDOC First Public Draft PDF-File (2007-11-03)

Additional Resources

If you want to get a first insight, you can additionally read the originating articles about the topic:

•  Javadoc for CSS (english)
•  Adaption des Javadoc-Standards in CSS (deutsch)

Contact

You can reach us  by joining our mailinglist.

Concept

By using CSSDOC additional relevant information can be placed into CSS comments. This is done by using the concept of DockBlocks. This concept of Short/Long comment and @tag-tags can be easily used within CSS as well. This document suggests how DocBlock and Tags are used. If you don't know what both are, please learn about those things before you continue.

Structure of a CSS File

This might be incorrect but currently we think that any CSS File is not structured or structured into sections. CSSDOC divides the file into different parts which are defined by one File-DocBlock and zero or more Section-DocBlocks. The File-DocBlock will open the file, a Section-comment starts a new section. At the end of a section you can additionally place one or more Hack-Comments if you feel in the need to comment so called CSS-Fixes or CSS-Hacks.

Next to these parts of a file, each DocBlock can and sometimes must contain certain tags. This differs from existing tags and their usage in PHP or Java, because CSS is not a programming language. But some parts are quite comparable because CSS files are being written.

More Info

Please read the PDF file for more Info.