C#扩展——自定义VS公/私有方法代码片段

最新推荐文章于 2024-04-23 22:35:38 发布

ۓ明哲ڪ

最新推荐文章于 2024-04-23 22:35:38 发布

阅读量629

点赞数 1

分类专栏： Unity C#常见问题文章标签： c# 开发语言

本文链接：https://blog.csdn.net/weixin_45532761/article/details/126453332

版权

Unity C#常见问题专栏收录该内容

12 篇文章 0 订阅

订阅专栏

声明：本文为个人笔记，用于学习研究使用非商用，内容为个人研究及综合整理所得，若有违规，请联系，违规必改。

文章目录

前言
一、实现原理
二、效果及源码展示
常见片段
文件资源下载链接
总结

前言

为了在写代码时更方便的声明方法,自定义了对应代码片段.文末附文件下载地址(免费).

一、实现原理

通过visual studio 自带的代码管理工具实现.
菜单栏——工具——代码片段管理器(Ctrl+K,Ctrl+B),打开后添加自己写好的就行了.

文件夹位置:
C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC#\Snippets\2052\Visual C#
在这里插入图片描述

二、效果及源码展示

1.效果

效果描述:
仅通过pru/prv (自定的public /private void 的缩写)
效果图如下:

请插入图片

2.源码展示

私有

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>prv</Title>
      <Shortcut>prv</Shortcut>
      <Description>
        自动实现的私有方法的代码片段
        语言版本:  C# 3.0 或更高版本
      </Description>
      <Author>Microsoft Corporation</Author>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>type</ID>
          <ToolTip>返回值类型 </ToolTip>
          <Default>void</Default>
        </Literal>
        <Literal>
          <ID>function</ID>
          <ToolTip>方法名称</ToolTip>
          <Default>MethodName</Default>
        </Literal>
      </Declarations>
      <Code Language="csharp">
        <![CDATA[private $type$ $function$ ( $selected$)
                {
                   $selected$ $end$
                }]]>
      </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>pru</Title>
      <Shortcut>pru</Shortcut>
      <Description>
        自动实现的公有方法的代码片段
        语言版本:  C# 3.0 或更高版本
      </Description>
      <Author>Microsoft Corporation</Author>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>type</ID>
          <ToolTip>返回值类型 </ToolTip>
          <Default>void</Default>
        </Literal>
        <Literal>
          <ID>function</ID>
          <ToolTip>方法名称</ToolTip>
          <Default>MethodName</Default>
        </Literal>
      </Declarations>
      <Code Language="csharp">
        <![CDATA[public $type$ $function$ ( $selected$)
                {
                   $selected$ $end$
                }]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

3.模板

(本文的prv和pru是通过prop的自动属性代码更改而来的.并非以下模板)

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>methodAsync</Title> <!-- 标题，必须的。-->
            <Shortcut>methodAsync</Shortcut> <!-- ***快捷键名称，是在VS里输入的，重要！-->
            <Description>Code snippet for an async method</Description><!-- 描述，可选，不重要 -->
            <Author>jinyafeng</Author> <!--作者，可选，不重要。 -->
            <SnippetTypes> <!--片段类型，可选，不重要。 -->
                <SnippetType>Expansion</SnippetType> <!--代表基本类型，代码片段直接插入光标处，还有其他类型，如SurroundsWith，会把你选择的代码片段包进去，不好用不推荐。-->
            </SnippetTypes>
        </Header>
        <Snippet>
            <Declarations> <!--可以定义多个变量。-->
                <Literal> <!--单个变量的定义-->
                    <ID>accessbility</ID> <!--***变量名称，重要！-->
                    <ToolTip>Accessbility</ToolTip> <!--提示，可选，不重要-->
                    <Default>public</Default><!--默认的文本值，可选，但有用。-->
                </Literal>
                <Literal>
                    <ID>return</ID>
                    <ToolTip>Return Type</ToolTip>
                    <Default>int</Default>
                </Literal>
                <Literal>
                    <ID>method</ID>
                    <ToolTip>Method name</ToolTip>
                    <Default>MyMethod</Default>
                </Literal>
                <Literal>
                    <ID>parameter</ID>
                    <ToolTip>Parameter name</ToolTip>
                    <Default></Default>
                </Literal>
            </Declarations>
            <!--***核心定义阶段，其中 <![CDATA[]]> 是固定的格式。无需关心，真正关心的是里面的[]的内容，为变量+文本，而变量用双$$表示。-->
            <!-- Language 选择对应的语言，目前支持 VB,CSharp,CPP,XAML,XML,JavaScript,TypeScript,SQL,HTML-->
            <!--$end$ 是一个特殊变量，代表着按回车键 回到的地方，以继续写代码。-->
            <Code Language="csharp"><![CDATA[$accessbility$ async Task<$return$> $method$Async($parameter$)
            {
                $end$
            }
        ]]>
            </Code>
            <Imports> <!--要导入的命名空间列表。可选。-->
                <Import> <!--单个命名空间导入定义,如果当前文件已经导入，则不会重新导入。-->
                <Namespace>System.Threading.Tasks</Namespace>
                </Import>
            </Imports>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

常见片段

Visual Studio for C# 默认包含以下代码片段。

#if 创建 #if 指令和 #endif 指令。任何位置。
#region 创建 #region 指令和 #endregion 指令。任何位置。
~ 创建包含类的终结期（析构函数）。在类中。
attribute 为派生自 Attribute 的类创建声明。在命名空间（包括全局命名空间）、类或结构中。
checked 创建 checked 块。在方法、索引器、属性访问器或事件访问器内。
class 创建类声明。在命名空间（包括全局命名空间）、类或结构中。
ctor 创建包含类的构造函数。在类中。
cw 创建对 WriteLine 的调用。在方法、索引器、属性访问器或事件访问器内。
do 创建 dowhile 循环。在方法、索引器、属性访问器或事件访问器内。
else 创建 else 块。在方法、索引器、属性访问器或事件访问器内。
枚举创建枚举声明。在命名空间（包括全局命名空间）、类或结构中。
equals 创建一个方法声明，该声明对 Object 类中定义的 Equals 方法进行重写。在类或结构中。
exception 为某个从异常（默认情况下为 Exception）派生的类创建声明。在命名空间（包括全局命名空间）、类或结构中。
for 创建 for 循环。在方法、索引器、属性访问器或事件访问器内。
foreach 创建 foreach 循环。在方法、索引器、属性访问器或事件访问器内。
forr 创建 for 循环，每次迭代后会减少循环变量。在方法、索引器、属性访问器或事件访问器内。
if 创建 if 块。在方法、索引器、属性访问器或事件访问器内。
索引器创建索引器声明。在类或结构中。
interface 创建接口声明。在命名空间（包括全局命名空间）、类或结构中。
invoke 创建安全调用事件的块。在方法、索引器、属性访问器或事件访问器内。
iterator 创建迭代器。在类或结构中。
iterindex 使用嵌套类创建“已命名”迭代器和索引器对。在类或结构中。
lock 创建 lock 块。在方法、索引器、属性访问器或事件访问器内。
mbox 创建对 System.Windows.Forms.MessageBox.Show 的调用。可能还需要添加对 System.Windows.Forms.dll 的引用。在方法、索引器、属性访问器或事件访问器内。
命名空间创建命名空间声明。在命名空间（包括全局命名空间）中。
prop 创建自动实现的属性声明。在类或结构中。
propfull 创建具有 get 和 set 访问器的属性声明。在类或结构中。
propg 创建具有专用 set 访问器的只读自动实现的属性。在类或结构中。
sim 创建 staticint Main 方法声明。在类或结构中。
struct 创建结构声明。在命名空间（包括全局命名空间）、类或结构中。
svm 创建 staticvoid Main 方法声明。在类或结构中。
开关创建 switch 块。在方法、索引器、属性访问器或事件访问器内。
尝试创建 try-catch 块。在方法、索引器、属性访问器或事件访问器内。
tryf 创建 try-finally 块。在方法、索引器、属性访问器或事件访问器内。
unchecked 创建 unchecked 块。在方法、索引器、属性访问器或事件访问器内。
unsafe 创建 unsafe 块。在方法、索引器、属性访问器或事件访问器内。
using 创建 using 指令。在命名空间（包括全局命名空间）中。
while 创建 while 循环。在方法、索引器、属性访问器或事件访问器内。