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

Idiomatic-CSS-Comments-Snippets

by chrisborrowdale ST2/ST3

CSS and Sass style comments for Sublime Text

Labels snippets

Details

  • 2015.10.22.07.46.38
  • github.​com
  • github.​com
  • 2 years ago
  • 13 minutes ago
  • 4 years ago

Installs

  • Total 5K
  • Win 3K
  • OS X 2K
  • Linux 540
Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6
Windows 1 0 2 2 2 5 0 2 1 1 2 2 2 2 1 3 4 1 4 2 1 2 1 3 2 2 1 2 5 4 3 5 4 4 2 3 1 3 4 1 1 1 1 1 6 6
OS X 0 1 2 0 3 1 0 2 0 2 0 1 1 0 2 1 1 2 0 1 0 1 0 1 0 2 1 0 1 2 1 2 1 1 0 1 1 1 0 2 0 0 0 0 0 0
Linux 1 0 1 0 2 0 0 0 1 0 0 0 0 0 0 1 1 0 1 1 1 0 0 0 0 0 2 0 0 2 0 0 1 1 0 2 0 0 0 1 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.