Sei sulla pagina 1di 1

Version 0.2.

22
Tag @affected Values Browser and version, or a group of useragents Identity of the author, probably email None Location File Comment Section Comment File Comment Usage Name a browser version for a bugfix or workaround

CSS DocBlock Structure

@author

@bugfix

@colordef @copyright @creator

CSS color value, name and usage Copyright string Name of creating application Name of fixed browser A CSSDoc Command Date (tag value) Fontdef (tag value) Timestamp of the last modification Might be a URL followed by a description Hyperlink Text Package name Section name Text, URL Version number Revision number Text Text Subpackage name Subsection name Subsubsection name List of tested browsers Text True/False Version Number None or short description of the bugfix

File Comment, Section Comment Standard CSS Comment File Comment File Comment File Comment

Name the author. For multiple authors use multiple tags, one per author. Documentation of CSS bugfixes. Use with: @affect, @css-for, @valid Definition of a color. Copyright information of file A CSS-Generating Application or Tool can leave its fingerprint here Naming the browser rules have been written for Controlling and signaling a CSSDoc parser Document creation date of file Definition of the fonts used in the document Document last date of modification

@css-for @cssdoc @date @fontdef @lastmodified

File Comment Section Comment File Comment Section Comment File Comment File Comment File Comment

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 */

@license

File Comment

To specify the license that the file is released under File referencing hyperlink Drop a note Associates one or multiple files to a package Open and name a new section Reference more info for a section or the file Reference since which version a section or file exists Reference since which version a section or file exists Name a site that this style has been made for Style that the file is part of Packaging Adding structure to a CSS file Adding structure to a CSS file Note which browsers a section has been tested with Create a todolist on the fly Can use with: @version Flag validity CSS Specify the file version Flag a workaround Use with: @bugfix (may replace it)

@link @note @package @section @see @since @since-revision @site @style @subpackage @subsection @subsubsection @tested @todo @valid @version @workaround

File Comment File Comment Section Comment File Comment Section Comment File Comment Section Comment File Comment Section Comment File Comment Section Comment File Comment File Comment File Comment Section Comment Section Comment File Comment Section Comment File Comment Section Comment File Comment Section Comment File Comment File Comment Section Comment

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 */

Developed by Talita Pagani

Last revision: 26 Dec. 2010

Potrebbero piacerti anche