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

CSS Comments

by brenopolanski ST2/ST3

CSS comments snippets for Sublime Text

Details

  • 2017.12.26.17.34.08
  • github.​com
  • github.​com
  • 1 year ago
  • 3 hours ago
  • 5 years ago

Installs

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

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