Using code snippets
All we mean by the term code snippets is a prepared code that we can read into our current script. This is especially easy with vim
being able to read the contents of other text files during editing:
ESC :r <path-and-filename>
For example, if we need to read the contents of a file called if
located in $HOME/snippets
, we will use the following key sequences in vim
:
ESC :r $HOME/snippets/if
The contents of this file is read into the current document below the current cursor position. In this way, we can make the code snippets as complex as we need and maintain the correct indentations to aide readability and consistency.
So, we will make it our duty to always create a snippets directory in our home directory:
$ mkdir -m 700 $HOME/snippets
It is not required to share the directory, so it is good practice to set the mode to 700
or private to the user when it is being created.
When creating snippets, it is your choice to use a pseudo-code or real examples. My preference is...