先ほどの記事とは逆で、ReSharperの支援を受けられない環境で、VSのコードスニペットを使ってStyleCop仕様のファイルヘッダを挿入する方法です。
コードスニペットの定義自体はEnrico CampidoglioさんがGistに公開してくれているので、それを使わせてもらいましょう。
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?xml version="1.0" encoding="utf-8"?> | |
<CodeSnippet Format="1.0.0" xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> | |
<Header> | |
<Title>File Header</Title> | |
<Author>Enrico Campidoglio</Author> | |
<Shortcut>fh</Shortcut> | |
<Description>Adds a StyleCop compliant file header comment with company and copyright information.</Description> | |
<SnippetTypes> | |
<SnippetType>Expansion</SnippetType> | |
</SnippetTypes> | |
</Header> | |
<Snippet> | |
<Declarations> | |
<Literal> | |
<ID>FileName</ID> | |
<ToolTip>The current file name.</ToolTip> | |
<Default>FileName</Default> | |
</Literal> | |
<Literal> | |
<ID>CompanyName</ID> | |
<ToolTip>The name of the company holding the copyright.</ToolTip> | |
<Default>CompanyName</Default> | |
</Literal> | |
</Declarations> | |
<Code Language="CSharp"> | |
<![CDATA[//----------------------------------------------------------------------- | |
// <copyright file="$FileName$.cs" company="$CompanyName$"> | |
// Copyright (c) $CompanyName$. All rights reserved. | |
// </copyright> | |
//----------------------------------------------------------------------- | |
$end$ | |
]]> | |
</Code> | |
</Snippet> | |
</CodeSnippet> |
これをFileHeader.snippetと言うファイルで適当な場所に保存します。
次にVisual Studioを起動し、ツールメニューからコードスニペットマネージャーを起動します。
インポートボタンをクリックして、先ほど保存したファイルを選択します。登録先はC#のMy Code Snippetsで良いと思います。
これで以下のように登録出来たと思います。
使い方は他のコードスニペットと同じなので、ソースコードファイルの先頭にカーソルを移動してコンテキストメニューか、ショートカット(Ctrl+K, Ctrl+x)でコードスニペットの挿入を選択、下図の様に登録したスニペットを選択します。
もしくはfhとタイプしてタブを2回キーしても同様です。
すると以下のようにヘッダが挿入されるので、オレンジ色で反転している部分を編集します。
以上です。
コメント