A software developer’s job mainly involves writing production code, and it’s easy to find yourself typing the same lines of code repeatedly as you work. This repetitive and inefficient task can certainly begin to feel mundane after a while, and as a result, your coding workflow may start to look like a chore.
One solution to this problem is to use code snippets to speed up and simplify the coding process. In this article, you’ll learn more about code snippets and how to create them in the Visual Studio (VS) code editor. In the end, you’ll also see how Pieces makes saving, using, and sharing code snippets even easier.
What Are Code Snippets?
Code snippets refer to ready-made bits of reusable source code that can be saved for reuse as needed. With code snippets, you can quickly insert the chunks of reusable code into your codebase, reducing the time you would spend repeatedly typing the same code and thus significantly speeding up your development workflow.
Generally speaking, it’s preferable to avoid repetition when there’s an obvious solution: You save contacts on your phone instead of typing the numbers for every phone call, and you let websites store cookies on your computer to remember your log-in details and preferences. Using code snippets follows this same line of thought.
Here are a few specific reasons code snippets can be helpful to you as a developer:
Increasing Development Speed
Imagine building a website of ten landing pages using HTML5. Typing the HTML document boilerplate for each page would be daunting and, frankly, a waste of your time.
With code snippets, you write the code and save it as a snippet. Then, you can easily reuse the snippet on each page to write the boilerplate in a templated fashion.
This way, you save yourself from unnecessary amounts of keystrokes, giving you the time to focus on other development needs. Especially when it comes to large blocks of code, it’s easy to see how using code snippets can be a significant productivity booster.
Preventing Typing Errors
Using code snippets also leaves little room for typographical errors. When repeatedly typing the same thing manually, you’re bound to make a mistake at least once. However, code snippets help you avoid such errors by providing a method to ensure consistent and fault-free syntax across your codebase since you have to type the code only once and can then reuse it multiple times.
Making Coding More Enjoyable
Finally, typing the same lines of code can make your coding workflow feel dull and mundane. Using code snippets helps to eliminate this mundane task, freeing up your mental resources to focus on writing enjoyable code that you’re actually interested in.
How to Create Code Snippets in VS Code
Now that you’re aware of the benefits code snippets provide to developers, let’s take a look at how you can create and use them.
Most code editors and IDEs have out-of-the-box support for code snippets, and VS Code is no exception. Follow the steps in the tutorial below to get started.
Step 1: Create a Snippet File
This will present you with a drop-down of different languages and selections to choose from:
Step 2: Define Your Snippet’s Scope
Next, you’ll need to define the snippet’s scope, which refers to the languages the snippet will be available in. VS Code supports two types of scopes:
- Global scope snippets: These are code snippets that can be used across several or all languages of your choice.
- Language-specific scope snippets: These snippets can only be used in a particular language.
For this tutorial, you will be creating a globally scoped snippet. From the drop-down list, select the New Global Snippets file option and then give the snippet file a name:
With that done, VS Code will create a new snippet file that includes a few comments and an example snippet, as pictured here:
Step 3: Write the Snippet’s Syntax
The example snippet code above is a sample template to show you the format for how to create your own snippet. Line by line, here’s an overview of what each field does:
- Print to console: This is the snippet’s name, which will also be displayed via IntelliSense if no description is provided. It is the property of the JSON object that will contain the actual details of the snippet.
- Prefix: This defines one or more words you need to type for the snippet to appear. In the example, you need to type “log” to display the snippet.
- Body: This is where you define the code snippet. It can be a string if it is a single line of code or an array of strings if it has multiple lines, where each string forms a new line in the snippet. In this example, the actual code is `console.log`.
- `$1` and `$2`: These are called tab stops. They enable you to pinpoint where the cursor should be placed within the code snippet after being injected and also allow you to tab through the code easily using the tab key. `$1` is simply a placeholder for where the cursor should be initially placed after invoking the snippet, and `$2` is the next point the cursor placement should move to after hitting the tab key.
- Description: This describes the code snippet by allowing you to provide details on what it is all about. If it is omitted, the name of the snippet will be used instead. In this example, the description tells you that the snippet’s purpose is to “log output to console.”
Now that you have an example code snippet saved, let’s take a look at how you can use it in your code.
Using VS Code Snippets in Your Workflows
There are several ways you can use this snippet in your actual development workflow. Here’s a quick overview of a few of them.
Using VS Code IntelliSense
VS Code IntelliSense is the easiest way to use code snippets. It automatically aids you by providing autosuggestion and autocompletion, among several other features. To use VS Code IntelliSense, start by typing the prefix for the snippet. This will display a context menu with hints at what you might be trying to achieve:
You can then select the code snippet by hitting the tab key to automatically insert it into your code:
As you can see, the cursor is immediately placed where the `$1` placeholder was in the snippet’s file.
Using the Snippet Picker
Another method to use snippets in your code is with VS Code’s Code Snippet Picker. Open the command palette and type “insert” into the search bar. Then select the Insert Snippet option.
This displays a drop-down list of all the custom VS Code snippets you have created:
From here, you can select the appropriate snippet, and it will be inserted into your code.
Using Pieces — a Better Way to Save Code Snippets
As your snippets grow in lines and complexity, it can become difficult to go through the process of creating them in VS Code. Enter Pieces, the perfect tool to solve that problem.
Pieces is an artificial intelligence (AI) tool that allows you to instantly save code snippets from your web browser, code editor, and even images. Pieces makes the process of creating, finding, and using snippets a breeze.
Creating Code Snippets with Pieces
On a web browser, hover your cursor over any code block to display the Pieces widget. Clicking on that widget allows you to save that block of code to Pieces:
In your code editor, highlight the snippet with your mouse, right-click to open VS Code’s context menu, and click on Save to Pieces to save the snippet to Pieces:
With your snippets saved on Pieces, you can easily reuse them by clicking on the cascading-windows icon on the Pieces app sidebar to copy the snippet to your clipboard and then pasting it into your codebase.
Pieces offers a ton of unique features, such as auto-formatting your snippets; categorizing them by language and tags to enable you to quickly search for them; capturing the project, file name, and line numbers that the snippet came from in your editor; storing the URL that the snippet came from if you saved it from a web page; and many more.
Developers tend to carry out a lot of repetitive tasks during the course of development, which can really undermine efficiency when writing code. Using code snippets lets you focus on the right things while writing code and eases your entire development workflow.
In this article, you learned how to create code snippets in VS Code, as well as how to optimize your workflow using the Pieces app. To learn more, get started with Pieces for free today!