使用 Visual Studio 2010 创建我们自己的代码片段

关于本文

在本博客中，我将介绍在 Visual Studio 2010 IDE 中创建我们自己的代码片段的基础知识。

引言

基本上，Visual Studio 通过键入快捷方式并按 TAB 键来为我们编写一些代码。

Visual Studio 代码片段快捷方式列表

1. #if - 创建一个 #if 指令和一个 #endif 指令。
2. #region - 创建一个 #region 指令和一个 #endregion 指令。
3. ~ - 为包含类创建一个析构函数。
4. attribute - 创建一个类声明，该类派生自 Attribute。
5. checked - 创建一个 checked 块。
6. class - 创建一个类声明。
7. ctor - 为包含类创建一个构造函数。
8. cw - 创建一个对 WriteLine 的调用。
9. do - 创建一个 do while 循环。
10. else - 创建一个 else 块。
11. enum - 创建一个 enum 声明。
12. equals - 创建一个方法声明，该方法覆盖 Object 类中定义的 Equals 方法。
13. exception - 创建一个类声明，该类派生自异常（默认情况下为 Exception ）。
14. for - 创建一个 for 循环。
15. foreach - 创建一个 foreach 循环。
16. forr - 创建一个 for 循环，该循环在每次迭代后递减循环变量。
17. if - 创建一个 if 块。
18. indexer - 创建一个索引器声明。
19. interface - 创建一个接口声明。
20. invoke - 创建一个安全调用事件的块。
21. iterator - 创建一个迭代器。
22. iterindex - 通过使用嵌套类来创建“命名”迭代器和索引器对。
23. lock - 创建一个 lock 块。
24. mbox - 创建一个对 System.Windows.Forms.MessageBox.Show 的调用。您可能需要添加对 *System.Windows.Forms.dll* 的引用。
25. namespace - 创建一个 namespace 声明。
26. prop - 创建一个属性声明和一个后备字段。
27. propg - 创建一个只有“get”访问器和一个后备字段的属性声明。
28. sim - 创建一个 static int Main 方法声明。
29. struct - 创建一个 struct 声明。
30. svm - 创建一个 static void Main 方法声明。
31. switch - 创建一个 switch 块。
32. try - 创建一个 try-catch 块。
33. tryf - 创建一个 try-finally 块。
34. unchecked - 创建一个 unchecked 块。
35. unsafe - 创建一个 unsafe 块。
36. using - 创建一个 using 指令。
37. while - 创建一个 while 循环。

除了这些默认的代码片段之外，我们还可以创建自己的代码片段。通常，我们可以为跨项目的可重复代码编写自定义代码片段。

创建自定义代码片段

基本上，自定义代码片段保存在 * .snippet * 文件中，它是基于 XML 的文件，我们可以手动以代码片段可接受的格式创建此 XML 文件，并将其添加到 Visual Studio IDE 中。 用 XML 编写非常困难。

CodePlex 站点上提供了开源的 Snippet Designer。 它可以下载并安装在 Visual Studio 2010 IDE 中。 请参阅参考部分以下载 Snippet Designer。

步骤 1

选择一组想要创建代码段的代码，然后右键单击，从弹出菜单中选择“导出为代码段”。

它将使用选定的内容创建一个新的 *.snippet* 文件。

第二步

如下所示修改代码段名称和属性。 我们还可以在代码段中制作可修改的文本。 在这里，我将 arg1、arg2 配置为替换文本。

将此文件保存在本地路径中，文件夹名称为 *Snippet Demo*，名称为 *SnippetAdd.snippet*。

将自定义代码片段添加到 VS 2010 IDE

步骤 1

打开 VS 2010 IDE，然后选择“工具”菜单，然后单击“代码片段管理器”项。 仅当您安装 Snippet Designer 工具时，才会出现代码片段管理器。

这将打开“代码片段管理器”窗口。

第二步

单击“添加”按钮，然后选择包含 *SnippetAdd.snippet* 文件的文件夹 *Snippet Demo*。

它将创建文件夹名称 Snippet Demo 并创建一个名为 SnippetAdd 的代码段。

使用自定义代码段

步骤 1

在代码编辑器窗口中键入单词 SnippetAdd 并按 TAB 键，它将在 *snippetAdd.snippet* 文件中创建代码。

此处 arg1 和 arg2 是可编辑的变量，并且会自动替换所有其他引用它们的位置。

结论

我希望这篇博客能帮助您创建 Visual Studio 2010 中创建我们自己的代码段的基础知识。

参考文献

1. http://msdn.microsoft.com/en-us/library/ms165392(VS.80).aspx
2. http://snippetdesigner.codeplex.com/releases/view/50044