Automated CSS documentation 1

[MrGrey]

Hi,

Does anyone know if there is an automated documentation tool for CSS on the lines of JSDoc for Javascript. (ie. documentation created from inline code comments).

Thanks in advance.

 

[Ascalonian]

From my research, there is not a CSS Doc tool available.

However, there is one out there (that I use at the company I work for) that is able to support any language. It is all called Natural Docs. All you would need to do is edit the config file with some minor stuff (such as what is the beginning and end block quote look like. Typically "/* */"). Now, this is slightly different than JavaDoc though.

In this documentation tool, there are no set "tags" to use really. With some simple syntax, you can create your own tags as you go. An example below:

/*
    Class: requiredField
       This is used to make all fields that are required to have red text.

    See also:
        <warningField> 
*/
.requiredField {
    color: red;
}

That is all you need to do.

Check out the documentation at

http://www.naturaldocs.org/

I highly recommend this.

 

[MrGrey]

Many thanks.

 

[Ascalonian]

You are most certainly welcome )