ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

CSS Comments

by brenopolanski ST2/ST3

CSS comments snippets for Sublime Text

Details

  • 2015.12.24.15.08.52
  • github.​com
  • github.​com
  • 2 years ago
  • 1 hour ago
  • 4 years ago

Installs

  • Total 12K
  • Win 8K
  • OS X 3K
  • Linux 1K
Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28
Windows 11 13 7 6 8 15 11 12 14 4 10 13 11 12 10 7 12 7 12 6 2 12 14 5 10 10 14 8 12 16 6 9 18 10 7 14 16 11 10 11 14 9 14 14 9 9
OS X 4 2 3 0 2 3 4 0 3 0 1 1 2 1 2 1 1 0 5 2 2 1 2 0 3 1 0 1 1 1 1 0 3 5 2 3 2 1 2 2 0 2 2 2 2 3
Linux 0 1 1 1 1 3 0 2 0 0 0 2 0 0 1 0 0 0 2 1 2 2 0 1 1 2 2 0 0 2 1 0 2 1 0 1 2 2 0 2 1 1 1 0 0 2

Readme

Source
raw.​githubusercontent.​com

CSS Comments snippets Build Status

CSS Comments snippets

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:

image snippets

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

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m "Add some feature"
  4. Push to the branch: git push origin my-new-feature
  5. 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