Developed by Talita Pagani Last revision: 26 Dec. 2010

Version 0.2.22

Tag Values Location Usage CSS DocBlock Structure

Sample DocBlocks

File Comment /**

* My Website

*

* Standard layout for My Website

*

* This style sheet describes the

* structure and the main components

* about My Website interface

*

* @project My Website

* @version 1.0

* @package layout

* @author John Doe

* @copyright 2010 A Company, Inc.

*

* @colordef #069; standard blue

* @colordef #333; standard dark

* @colordef #666; standard gray

*/

Section Comment

/**

* Page Structure

*

* Main structure and common

* components of website

* such as Wrapper, Navbar, Header and

* Footer

*

* @section structure

* @see http://www.example.com

*/

Bugfix

/**

* Disappearing list-background bug

*

* @bugfix

* @affected IE 5.x/Win, IE6

* @css-for IE 5.x/Win, IE6

* @valid true

*/

@affected Browser and version, or a group of useragents

File Comment

Section Comment

Name a browser version for a bugfix or workaround

@author Identity of the author, probably email

File Comment Name the author. For multiple authors use multiple tags, one per author.

@bugfix None File Comment,

Section Comment

Standard CSS Comment

Documentation of CSS bugfixes. Use with: @affect, @css-for, @valid

@colordef CSS color value, name and usage

File Comment Definition of a color.

@copyright Copyright string File Comment Copyright information of file

@creator Name of creating application

File Comment A CSS-Generating Application or Tool can leave its fingerprint here

@css-for Name of fixed browser

File Comment

Section Comment

Naming the browser rules have been written for

@cssdoc A CSSDoc Command

File Comment

Section Comment

Controlling and signaling a CSSDoc parser

@date Date (tag value) File Comment Document creation date of file

@fontdef Fontdef (tag value)

File Comment Definition of the fonts used in the document

@lastmodified Timestamp of the last modification

File Comment Document last date of modification

@license Might be a URL followed by a description

File Comment To specify the license that the file is released under

@link Hyperlink File Comment File referencing hyperlink

@note Text File Comment

Section Comment

Drop a note

@package Package name File Comment Associates one or multiple files to a package

@section Section name Section Comment Open and name a new section

@see Text, URL File Comment

Section Comment

Reference more info for a section or the file

@since Version number File Comment

Section Comment

Reference since which version a section or file exists

@since-revision Revision number File Comment

Section Comment

Reference since which version a section or file exists

@site Text File Comment Name a site that this style has been made for

@style Text File Comment Style that the file is part of

@subpackage Subpackage name

File Comment Packaging

@subsection Subsection name

Section Comment Adding structure to a CSS file

@subsubsection Subsubsection name

Section Comment Adding structure to a CSS file

@tested List of tested browsers

File Comment

Section Comment

Note which browsers a section has been tested with

@todo Text File Comment

Section Comment

Create a todolist on the fly

Can use with: @version

@valid True/False File Comment

Section Comment

Flag validity CSS

@version Version Number File Comment Specify the file version

@workaround None or short description of the bugfix

File Comment

Section Comment

Flag a workaround

Use with: @bugfix (may replace it)