Having great samples to help you learn about any programming language or paradigm can be very valuable. In my opinion, a good sample can be characterized by:
Being easy to replicate
Having clear steps that guide the reader to replicating the behavior of the sample into their own code base is paramount. Without clear guidance and explanation on how to consume the sample, the sample is much less efficient and may lead to the reader becoming annoyed.
The sample needs to contain the needed documentation, code comments and simplicity that makes it easy to understand. It must keep the concept count to a minimum to reduce noise.
Linking to additional resources
A sample is not a replacement for full documentation but shows how to implement concepts that can pan multiple sets of documentation. If the reader is interested in knowing more details about the various technologies and concepts used by the sample, links must be made available.
Being able to build and run
It should be possible to clone the sample to your machine, open it in Visual Studio and being able to run and debug effortlessly. Setting breakpoints and inspecting the code is a fantastic way to help understand how the sample works.
The Visual Studio extensibility team has a notable set of samples for various different aspects of writing extensions. However, they do not adhere to the rules outlined above and we are looking into updating them accordingly and adding new ones as well.
So, we’ve created some experimental samples on GitHub that addresses some pain points we’ve noticed over the years. They are:
- Doing options the right way - This sample shows how to correctly specify and consume options for a Visual Studio extension that is both thread-safe and performant.
- VisibilityConstraints - This sample shows how to use the <VisibilityConstraints> element in a Visual Studio extension to remove the need to use the ProvideAutoload attribute on a package class.
- Protocol Handlers - This sample shows how to associate a URI protocol with Visual Studio and handle the passed in URI. For instance, a link with a custom protocol (such as vsph://anything/I/want) will open Visual Studio and pass the URI to the extension.
- Textmate Grammar - This is a sample project that demonstrates how to ship Textmate grammars inside Visual Studio extensions.
Give us feedback
Please help give us feedback on these new types of samples by either commenting on this blog post or, even better, opening issues directly on the samples on GitHub. The more feedback we get, the better the samples get, and we can start writing lots more of them.
Also, what scenarios should the next batch of Visual Studio extensibility samples address?