C#中的Code Snippet

一.什么是Code Snippet

Code Snippet（代码片段）是一种在敲出几个关键词时，IDE（通常是Visual Studio或VS Code）自动补全一段固定格式的完整代码模板的功能。能帮助快速生成常用代码结构，比如属性、方法、for循环、if语句等，非常适合提升开发效率。大部分IDE中都支持几乎所有主流的语言对应的Snippet，实现方法可能有小差异，但核心功能类似。

输入关键词后前面出现小方框的选项就是Snippet：

• 例如在Visual Studio 2022中输入prop选择Snippet然后按下Tab键，就能自动生成一个属性定义的模板：

public int MyProperty { get; set; }  

• 若输入foreach选择Snippet然后按下回车， 就能自动生成一个foreach循环的模板：

注：第一个选项是关键字选项，也能生成固定模板，但根据验证，该选项没有根据上下文自动填充信息的功能

foreach (var item in collection)
{

}

 若其附近上下文有可用信息，也可以自动填充，如其附近有一个color列表，则生成代码如下：

List<string> colors = new List<string>();
foreach (var item in colors)
{
    
}

 二.常用C# Code Snippet列表（Visual Stuido 2022）

快捷键	说明
prop	自动属性
propfull	完整属性
ctor	构造函数
cw	Console.Writeline()
for	for循环
foreach	foreach循环
if	if语句结构
else	else结构
switch	switch-case结构
try	try-catch结构
tryf	try-finally结构
using	using块（资源管理）
while	while循环
do	do-while循环
lock	lock ( obj ) {} 同步语句
checked	checked {} 溢出检查
unsafe	unsafe {} 非安全代码块
interface	接口定义
enum	枚举定义
namespace	命名空间结构
class	类定义结构
struct	结构体定义
indexer	索引器（this[......]）定义
attribute	自定义属性类模板

三.如何使用Code Snippet

以在Visual Studio/ VS Code中为例：

1.输入关键词，比如prop

2.按回车键或Tab一次（或两次，具体看IDE设置）

3.IDE会自动展开代码模板，并高亮可编辑部分（可以按Tab在各部分跳转）