Last active
August 29, 2015 13:57
-
-
Save wfendler/9811680 to your computer and use it in GitHub Desktop.
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
// | |
// Bootstrap Less | |
// -------------------------------------------------- | |
/** | |
* Suit.css Component Name | |
*/ | |
/*------------------------------------*\ | |
INUIT PAGE HEADING | |
\*------------------------------------*/ | |
/** | |
* Inuit Component w/code example | |
* | |
`@include vendor(border-radius, 4px);` | |
* | |
*/ | |
// | |
// ZURB Component Badge | |
// |
Another thing to consider is how Sass will output the comments. Ideally, each project will be minified and have 0 comments on production, but sometimes stuff unintentionally makes it up w/some comments.
/* These get rendered */
and // These do not
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I like how suit is annotated w/numbers for the less-obvious pieces of code. The self-explanatory rules are not explained but the more-obscure ones (in this case,
max-width
) are explained in an easy-to-follow way.