Visual Studio Code is taking the world by storm. I have a new nursery rhyme that I am going to teach my children:
I’ll teach them grammar later. After they learn to avoid Vim, then the rest of life will make more sense.
We all work with grumpy people — “elite” neckbeards that shun VS Code and sunlight and don’t trust the texture of hummus — but even these curmudgeons can’t deny VS Code’s popularity or the quality of the extensions. More importantly, we can all agree that every organization can improve their code documentation and ability to spin-up new developers.
CodeTour creates wizards which walk users through lines of code across any files in the repository. This extension is re-orienting how I feel about code completeness, documentation, and transparency.
The tour creates several
.json files that go in the
./vscode folder. You can edit these by hand
or use their wizard.
The tours available are shown in the tree view:
I easily wrote a tour that included:
1) a markdown file:
One problem that makes me wince is that a preview window is shown for every file type. (I didn’t even know that a preview could pop-up for a
.js file!) This might be a local environment issue because the gifs that they have on their documentation don’t show this issue. The project is currently only in version
0.0.11 so I am not too
concerned about the preview window.
Even if your project isn’t compatible with VS Code like an old ASP.NET WebForms project, it is still worth exploring the use of VS Code so you can have a code walkthrough each of the files.