本文主要:如何制作Visual Studio 代码段,代码段作用,和如何使用。

我们有时候会打出很多重复的代码,只是结构一样。 例如属性

        /// <summary>
        /// 编码
        /// </summary>
        public Encoding encoding
        {
            set
            {
                _encoding = value;
            }
            get
            {
                return _encoding;
            }
        }
        private Encoding _encoding=Encoding.UTF8;

属性我们可以使用 prop*按两次tab输入 例如 propfull

        private string myVar;

        public string MyProperty
        {
            get { return myVar; }
            set { myVar = value; }
        }

propfull

但很多时候我们需要 使用通知OnPropertyChanged

这样每个都来增加一句OnPropertyChanged工作量重复很多。

在之前,我就知道了有代码段,但是实在复杂,好在最近时间多,仔细看了一下。

代码片段是小块可重用的代码,可使用上下文菜单命令或热键组合将其插入代码文件中。 代码片段通常包含常用的代码块(如 try-finally 或 if-else 块),可用于插入整个类或方法。

代码段使用很简单 在类中,如果我们需要输入try-catch,我们可以按

try tab tab

try tab tab

    try 
	{	        
		
	}
	catch (Exception)
	{

		throw;
	}

可以使用

Ctrl+K 和 X 或 Ctrl+K 和 S

visual studio有的参见:https://msdn.microsoft.com/zh-cn/library/z41h7fat.aspx

创建代码段可以使用snippet editor

但是这个是比较旧

我们可以使用创建模板

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets
    xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title></Title>
    </Header>
    <Snippet>
      <Code Language="">
        <![CDATA[]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

我们可以在visual studio创建xml文件写

如果使用笔记本,编码为utf-8开始我弄成ascii就错了

代码段最先是CodeSnippets

CodeSnippets说明xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet" 然后是格式

<CodeSnippet Format="1.0.0">

下来Header

里面有标题、作者、描述、快捷键信息 标题是必填

<Title>标题</Title>

作者可以选,描述可以选

<Author>lindexi_gd</Author>
 <Description>描述</Description>

快捷键不是按下同时键,是输入一段代码就可以按tab的文字

<Shortcut>ps</Shortcut>

代码段核心是<Snippet> 里面有<Declarations>描述,code <Declarations>可以写每个参数的描述 例如do

			<Declarations>
				<Literal>
					<ID>expression</ID>
					<ToolTip>要计算的表达式</ToolTip>
					<Default>true</Default>
				</Literal>
			</Declarations>

ID写在![CDATA[使用变量名,<ToolTip>描述,<Default>默认值

do

代码写在![CDATA[ 需要先写语言Language="csharp" 我们用do代码

			<Code Language="csharp"><![CDATA[do
	{
	        $selected$ $end$
	} while ($expression$);]]>
			</Code>

模板参数: 模板参数声明和启用用两个$$把变量名写在$parameter$![CDATA[可以使用$parameter$变量 有一些变量名不能使用,可以在https://msdn.microsoft.com/zh-cn/library/eehb4faa.aspx

导入代码段 导入代码段

这里写图片描述

这里写图片描述

我们可以把之前写的prop导入到代码段,按ps tab 这里写图片描述

我们可以使用$selected$$end$ 来定位代码光标的开始

在code可以加上Delimiter Delimiter 可选特性。指定用于描述代码中的文本和对象的分隔符。默认情况下,分隔符为 $。 kind 代码段必须插入位置,方法,类中

https://msdn.microsoft.com/zh-cn/library/ms171418.aspx

一些常用 ps

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>ps</Title>
      <Author>lindexi</Author>
      <Description>插入属性</Description>
      <HelpUrl />
      <SnippetTypes />
      <Keywords />
      <Shortcut>ps</Shortcut>
    </Header>
    <Snippet>
			<Declarations>
				<Literal>
					<ID>string</ID>
					<Default>string</Default>
					<ToolTip>类型名</ToolTip>
				</Literal>
				<Literal>
					<ID>name</ID>
					<Default>name</Default>
					<ToolTip>属性名</ToolTip>
				</Literal>
			</Declarations>
      <Code Language="csharp" kind="method decl"><![CDATA[public $string$ $name$
{
    set
    {
         _$name$=value;         
    }
    get
    {
         return _$name$;
    }
}
$slected$ $end$
private $string$ _$name$;]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

pvs

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>pvs</Title>
      <Author>lindexi</Author>
      <Description>插入属性</Description>
      <HelpUrl />
      <SnippetTypes />
      <Keywords />
      <Shortcut>pvs</Shortcut>
    </Header>
    <Snippet>
			<Declarations>
				<Literal>
					<ID>string</ID>
					<Default>string</Default>
					<ToolTip>类型名</ToolTip>
				</Literal>
				<Literal>
					<ID>name</ID>
					<Default>name</Default>
					<ToolTip>属性名</ToolTip>
				</Literal>
			</Declarations>
      <Code Language="csharp" kind="method decl"><![CDATA[public $string$ $name$
{
    set
    {
         _$name$=value;
         OnPropertyChanged("$name$");
    }
    get
    {
         return _$name$;
    }
}
$slected$ $end$
private $string$ _$name$;]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>
<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>cla</Title>
      <Author>lindexi</Author>
      <Description></Description>
      <Shortcut>cla</Shortcut>
    </Header>
    <Snippet>
			<Declarations>
				<Literal>
					<ID>name</ID>
					<Default>name</Default>
					<ToolTip></ToolTip>
				</Literal>
			</Declarations>
      <Code Language="csharp" kind="method decl"><![CDATA[
/// <summary>
///
/// </summary>
public class $name$
{
        public $name$()
        {

        }
$slected$ $end$
}
]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

如果需要使用Resharper的代码段,请看resharper 自定义代码片


本文会经常更新,请阅读原文: https://lindexi.gitee.io/lindexi/post/%E4%BB%A3%E7%A0%81%E6%AE%B5.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

知识共享许可协议 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名林德熙(包含链接: https://lindexi.gitee.io ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系