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

Idiomatic-CSS-Comments-Snippets

CSS and Sass style comments for Sublime Text

Labels snippets

Details

  • 2015.10.22.07.46.38
  • github.​com
  • github.​com
  • 8 years ago
  • 1 hour ago
  • 11 years ago

Installs

  • Total 10K
  • Win 7K
  • Mac 2K
  • Linux 728
Mar 1 Feb 29 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 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16
Windows 0 1 0 4 0 0 0 2 3 1 3 3 1 2 2 0 0 0 2 2 2 0 0 4 0 1 1 0 1 1 0 0 2 0 1 0 1 1 1 0 0 2 1 1 1 2
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 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 0 0 0 0
Linux 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 0 1

Readme

Source
raw.​githubusercontent.​com

Idiomatic CSS Comments for Sublime Text

Idiomatic CSS style comments for Sublime Text. Comment format based on Idiomatic CSS by @necolas.

Thanks to @scottyeck there are Sass style comments also available.

Install

You can install via the Sublime Text Package Control (http://wbond.net/sublime_packages/package_control) and search for Idiomatic CSS Comments.

Usage

There are several shortcuts for the different comment blocks.

Basic Comment

Enter the shortcut com-basic followed by the tab key

/* This is a basic comment */

Section Comment

Enter the shortcut com-section followed by the tab key

/* ==========================================================================
   This is a Section Comment
   ========================================================================== */

Sub-Section Comment

Enter the shortcut com-sub followed by the tab key

/*
   This is a sub-section comment
   ========================================================================== */

Long Comment

Enter the shortcut com-long followed by the tab key

/**
 * 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.
 */

Todo List Comment

Enter the shortcut com-todo followed by the tab key

/**
 * TODO:
 *
 * => Write some code
 * => Make some lists
 *
 */

Sass-style Comments

Each of the comment-types listed above can be rendered in the form of a Sass-style comment using the shortcuts listed below.

  • Basic Comment (Sass) - com-sass-basic
  • Section Comment (Sass) - com-sass-section
  • Sub-Section Comment (Sass) - com-sass-sub
  • Long Comment (Sass) - com-sass-long
  • Todo List Comment (Sass) - com-sass-todo

As before, each shortcut should be followed by the tab key.