使用 Code Snippet 來增加寫 Code 效率

2020-04-16

在 Visual Studio 裡，有許多工具或套件可以讓你可以很快或是少寫很多 Code 就完成任務，除了自行開發的 Extension 之外，還有 Code Snippet 這項工具可以讓你增加產出。

Code Snippet 並不是一個太新的東西

早在 2010 前就已經有的東西，只是相見恨晚

使用內建的 Code Snippet

只要你安裝了 Visual Studio，也就意謂著你也擁有了一些 Code Snippet 的工具了

在一個 class 裡打上 ctor 加上兩個 tab，即可快速產生 constructor 的函式

這就是 code snippet 所能幫你減少的開發時間

詳情請見
https://drive.google.com/file/d/1ACfx6Ywr1ipfrw7tFY0S_Pa-TEDLht5T/view?usp=sharing

怎麼做到的?

安裝環境為 vs2019 preview，可在本機目錄中的 C:\Program Files (x86)\Microsoft Visual Studio\2019\Preview\VC#\Snippets\1033\Visual C# 中找到 ctor.snippet

    <Shortcut>ctor</Shortcut>
    ...
    ...
    <Code Language="csharp"><![CDATA[public $classname$ ()
	{
		$end$
	}]]>
	</Code>

看到這段，我想你應該就明白是怎麼一回事了

而其中比較特別的就是這段了

			<Declarations>
				<Literal Editable="false">
					<ID>classname</ID>
					<ToolTip>Class name</ToolTip>
					<Function>ClassName()</Function>
					<Default>ClassNamePlaceholder</Default>
				</Literal>
			</Declarations>

參數中的 $classname 若是在 class 裡的話，這個變數就會抓取該 class 的名稱當作值

但若不是的話，則會帶上預設的參數 ClassNamePlaceholder 到此程式碼片段之中

打造自己的 Code Snippet

比方說我們很常使用 public void method 這樣的 method 建立方式

每次都要打一樣的程式碼好麻煩

我們從 ctor 複製一份出來修改，把 title, shortcut 改成 cm

再把declartion 那塊移除，並修改我們要的 Code 的部份

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
	<CodeSnippet Format="1.0.0">
		<Header>
			<Title>cm</Title>
			<Shortcut>cm</Shortcut>
			<Description>Code snippet for constructor</Description>
			<Author>Microsoft Corporation</Author>
			<SnippetTypes>
				<SnippetType>Expansion</SnippetType>
			</SnippetTypes>
		</Header>
		<Snippet>
			
			<Code Language="csharp"><![CDATA[public void MyMethod{
			;
			}]]>
			</Code>
		</Snippet>
	</CodeSnippet>
</CodeSnippets>

接著看一下結果，在 VS 上打上 cm加上兩個 tab，即會出現我們所建立的快捷鍵程式碼詳情請見
https://drive.google.com/file/d/1OHxi8L9ENPewxspCY9CLP4YcbgiPSg-8/view?usp=sharing