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
  • 4 years ago
  • 2 hours ago
  • 6 years ago

Installs

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

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.