CSS Comments
CSS comments snippets for Sublime Text
Details
Installs
- Total 25K
- Win 19K
- Mac 5K
- Linux 2K
Jul 26 | Jul 25 | Jul 24 | Jul 23 | Jul 22 | Jul 21 | Jul 20 | Jul 19 | Jul 18 | Jul 17 | Jul 16 | Jul 15 | Jul 14 | Jul 13 | Jul 12 | Jul 11 | Jul 10 | Jul 9 | Jul 8 | Jul 7 | Jul 6 | Jul 5 | Jul 4 | Jul 3 | Jul 2 | Jul 1 | Jun 30 | Jun 29 | Jun 28 | Jun 27 | Jun 26 | Jun 25 | Jun 24 | Jun 23 | Jun 22 | Jun 21 | Jun 20 | Jun 19 | Jun 18 | Jun 17 | Jun 16 | Jun 15 | Jun 14 | Jun 13 | Jun 12 | Jun 11 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 1 | 1 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 2 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 |
Mac | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
CSS Comments snippets ![Build Status](/readmes/img/2808cc1da0118434b8502848d3c6290e5b7e90c2.svg)
CSS comments snippets for Sublime Text.
Well commented code is extremely important. Take time to describe components, how they work, their limitations, and the way they are constructed. Don't leave others in the team guessing as to the purpose of uncommon or non-obvious code.
Comment style should be simple and consistent within a single code base.
To install through Package Control, search for CSS Comments. If you still don't have Package Control in Sublime Text, go get it. If you insist to not install it, you can download the package and put it manually inside your Pacakages directory. It should work but will not update automatically.
Snippets
Works for CSS/LESS/Sass/SCSS/Stylus & PHP.
To trigger a comment just put a c- followed by it's name, like so:
Basic Comment
trigger: c-basic⇥
/* Basic comment */
Long Comment
trigger: c-long⇥
/*
* Long comment
*/
Section Comment
trigger: c-section⇥
/* ==========================================================================
Section comment block
========================================================================== */
Sub-section Comment
trigger: c-subsection⇥
/* Sub-section comment block
========================================================================== */
Multiple Comment with TODO
trigger: c-multi⇥
/**
* Short description using Doxygen-style comment format
*
* The first sentence of the long description starts here and continues on this
* line for a while finally concluding here at the end of this paragraph.
*
* The long description is ideal for more detailed explanations and
* documentation. It can include example HTML, URLs, or any other information
* that is deemed necessary or useful.
*
* @tag This is a tag named 'tag'
*
* TODO: This is a todo statement that describes an atomic task to be completed
* at a later date. It wraps after 80 characters and following lines are
* indented by 2 spaces.
*/
Summary Comment
trigger: c-summary⇥
/**
* Description: Short description.
* Version: 1.0.0
* Last update: YYYY/MM/DD
* Author: User Name <username@gmail.com>
*
* Summary:
*
* 0. ELEMENT
* - 0.1. TYPE ELEMENT
* - 0.2. TYPE ELEMENT
* 1. ELEMENT
* - 1.1. TYPE ELEMENT
* - 1.2. TYPE ELEMENT
*/
/* ==========================================================================
0. ELEMENT
========================================================================== */
/* 0.1. TYPE ELEMENT
========================================================================== */
/* 0.2. TYPE ELEMENT
========================================================================== */
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m "Add some feature"
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :)
English is the universal language nowadays, so please don't create or comment on issues using another language.
History
For detailed changelog, see Releases.
Credits
Comment format based on Idiomatic CSS by Nicolas Gallagher.
License
MIT License © Breno Polanski