Created
October 18, 2016 10:00
-
-
Save davidhund/d2cef3d0e993808697800bfb922bc965 to your computer and use it in GitHub Desktop.
Example of various CSS comment styles
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* = MAIN Comment Block | |
* | |
* A Main Comment Block for a file. Recognized by the | |
* 'heavy' bottom border. This comment lives at the top of a file and | |
* document's its function. | |
* | |
* ========================================================================= */ | |
/** | |
* = SECTION Comment Block | |
* | |
* A Section Comment Block document's a section. | |
* It has a 'lighter' bottom-border | |
* | |
* ------------------------------------------------------------------------- */ | |
/** | |
* = A SUBSECTION Comment Block | |
* | |
* A simple comment block, documenting some subsection/code | |
*/ | |
/* = An INLINE Comment */ | |
/* ! | |
* = PRESERVED Comment | |
* | |
* A line of text describing a *permanent comment*: a comment that is preserved | |
* in the processed CSS because it starts with an exclamation point: '!' | |
* | |
* Often contains: | |
* | |
* @version: 1.0 | |
* @author: David Hund <valuedstandards.com> | |
* etc... | |
* | |
*/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
tersffs