Teach you how to set up your own code snippets in Sublime3

The following tutorial column from sublime will introduce how to set up your own code snippets in Sublime3. I hope it will be helpful to friends in need!

Set your own code snippets in Sublime Text 3

When writing code, you often write the author, creation time, etc. in the comments. This way Now that you have left your mark, today I will teach you how to build your own comment code blocks (Snippets).

Sublime Snippets (Code Snippets)

Sublime text 3 Snippets are an important function you need when you need to repeatedly enter the same snippet of text or code.

Snippets can be stored in any package folder, but for simplicity, it is recommended to save them in the Packages/User directory first.

The file format of Snippets is .sublime-snippet, usually Snippet The structure is as follows

<snippet>
    <content><![CDATA[Type your snippet here]]></content>
    <!-- Optional: Tab trigger to activate the snippet -->
    <tabTrigger>xyzzy</tabTrigger>
    <!-- Optional: Scope the tab trigger will be active in -->
    <scope>source.python</scope>
    <!-- Optional: Description to show in the menu -->
    <description>My Fancy Snippet</description>
</snippet>

As long as we replace the content in CDATA with our own, we can complete the writing of the simplest Snippets.

Create your own Snippets

Next we will use our own code comments as an example to write a Snippet.

First, select Tools | Developer | New Snippets... in the sublime menu bar, and then enter

<snippet>
  <content><![CDATA[
/*
* @author:  ManiaU
* @createTime:  ${1:time}
* @description:  ${2:description}
*/
]]></content>
  <!-- Optional: Set a tabTrigger to define how to trigger the snippet -->
  <tabTrigger>comm</tabTrigger>
  <!-- Optional: Set a scope to limit where the snippet will trigger -->
  <scope>source.js</scope>
</snippet>

where content is the content of the Snippet, and tabTrigger is what you input that can be recognized as a Snippet. Scope represents the effective file format. In content, ${} is the content that can be selected by the tab key after you finish typing. ${1:} is the content that is selected directly after you finish typing. ${2:} is what is selected by pressing tab once. content, and so on.

Then save it as comment.sublime-snippet. Next, enter comm in a js file, press the tab keyboard, and your Snippet will appear.

Time input plug-in

Although Snippet is generated, the time is still not fixed. Next, create your own plug-in and select Tools | Developer | in the sublime menu bar. New Plugin..., enter the following content

import sublime, sublime_plugin
from time import localtime, strftime
class InsertDatetimeCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        sel = self.view.sel();
        for s in sel:
            self.view.replace(edit, s, strftime("%Y-%m-%d, %H:%M:%S GMT%z", localtime()))

and save it as insert_datetime.py, then add

{
  "keys": ["super+ctrl+t"],
  "command": "insert_datetime"
}

in Preference | Key Bindings. This means that you can insert the time by pressing ⌘ Control T. , with the above Snippet, after inserting comments, adding time and description, you can easily generate your own comments, as follows

/*
* @author:  ManiaU
* @createTime:  2017-03-14, 22:33:00 GMT+0800
* @description:  This is a test!
*/

Postscript

Of course, Snippets It’s not only useful. You can configure various fragments in your environment, which can greatly improve work efficiency. Let’s explore together!

The above is the detailed content of Teach you how to set up your own code snippets in Sublime3. For more information, please follow other related articles on the PHP Chinese website!