Skip to main content

Creating our own 'Code Snippets' in Visual Studio .NET 2005

Code Snippets are useful in situations where you frequently implement the same code blocks in multiple places within your project.

One could find all existing snippets for C# in this folder:
C:\Program Files\Microsoft Visual Studio 8\VC#\Snippets\1033\Visual C#

If you want to create your own snippet which is not existing in the above path then do the following:

1. In Visual Studio.NET, Create a New Xml File.
2. Place the following XML code into that file:

The root element for an code snippet is <CodeSnippet>. This would have two child elements <Header> and <Snippet>

<?xml version= "1.0" encoding="utf-8" ?>
<CodeSnippets xmlns = "http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
<CodeSnippet Format ="1.0.0">


<Header >
<Title> Title of the Code Snippet would come here </Title>
<Author> Vadivel Mohanakrishnan </Author>
<Description> Describe it in detail here </Description>
<Shortcut> vel </Shortcut>
</Header>

<Snippet>
<Code Language=" CSharp">
<![CDATA[
//Your code block needs to be placed here.
]]>
</Code>
</Snippet>

</CodeSnippet>
</CodeSnippets>

3. Using "Save As" dialog box, save it as 'MySnippet.snippet' on C drive (for example). Its because, Code Snippet is nothing but a XML file.

Now within your Visual Studio.NET 2005 do the following:

1. In the tools menu, select "Code Snippet Manager". Please note that by default "Code Snippet Manager" may not be visible. So go to Tools - Options and choose it for the first time.

2. Then, click on 'Import' button and locate the new snippet on your desktop. During that process if it throws an error like "The snippet files chosen were not valid" it means there is some error in the XML file. Fix it and try again.

3. Place the snippet under "My code snippets".

4. That's it you are done. Now open any file (.cs, class module etc.,) and right click and choose "Code Snippet". You could see our newly created snippet there. On click of it would place the code whatever we have written in our XML file.

5. Other way is to just type the shortcut (in this case its just vel) and press the TAB key.

For further reading on this topic I suggest you to go through these links: http://msdn.microsoft.com/vstudio/downloads/codesnippets/ and dotnetfun.com

Technorati tags: , ,

Comments

Anonymous said…
Awsome guide! thanks helped me alot to get my snippets working :)

Popular posts from this blog

My Wedding Anniversary :)

Six years back on the same day I married Sai Lakshmi (12-July-2000). I know Sai for almost 13 years now :) I fell in love with her during my 12th standard. I know @ 17 yrs any person wouldn't be matured enough to make a big decision like this. But thank God my choice was perfect :) Even now, very often we used to think about the past and laugh at our behaviors/actions then. My love story would be really interesting (at least for me and Sai :)) and I am sure none of you guys would be interested in reading about it so lemme not get into it in-depth. But one thing which I want to share is "Without Sai, I wouldn't have entered into the IT field at all". She was instrumental in convincing me to study my Master's degree in Computer Application. That's the move that changed my career. Till my schooling, my dream was to either become a "big" sportsman (Cricket and Badminton were my favorites at that time.) or an Aeronautics engineer. Unfortunately, my l...

Script table as - ALTER TO is greyed out - SQL SERVER

One of my office colleague recently asked me why we are not able to generate ALTER Table script from SSMS. If we right click on the table and choose "Script Table As"  ALTER To option would be disabled or Greyed out. Is it a bug? No it isn't a bug. ALTER To is there to be used for generating modified script of Stored Procedure, Functions, Views, Triggers etc., and NOT for Tables. For generating ALTER Table script there is an work around. Right click on the table, choose "Modify" and enter into the design mode. Make what ever changes you want to make and WITHOUT saving it right click anywhere on the top half of the window (above Column properties) and choose "Generate Change Script". Please be advised that SQL Server would drop actually create a new table with modifications, move the data from the old table into it and then drop the old table. Sounds simple but assume you have a very large table for which you want to do this! Then it woul...

What should one look @ while buying a land in chennai?

Offlate people have started thinking about investing their money in lands. I too think that to be a wise decision only! As most of us know buying a land in chennai (for that matter any where in the world) isn't an easy affair. I was just wondering what all one needs to look at before deciding to purchase a land. I thought I would put down what ever I know about this subject here. [Guys pls free to correct me if I my understanding is wrong somewhere. That way, it would help me understand as well as others who might read this in future]. Here we go ... 1. One should not buy farm lands if they want to build a residential house sometime later there. Because to my knowledge its illegal to build residential houses on lands meant for irrigation. 2. Encumberance Certificate -- This is what is shortly refered as "EC". One needs to get an EC from local sub registrar office (i guess we need pay a small amount for this). From this we / our lawyers :) can find out whether the guy who ...