直近の開発環境設定についてのメモ

今度やる案件で使うツールの導入と初期設定等をやっているので、ちょっとメモしておきます。

StyleCop

コードの規約違反を洗い出すツール。Visual Studioの拡張機能として導入し、プロジェクトを右クリックして実行すると、事前に決められたルールにソースが適合しているかどうかを確認して警告を出してくれるツールです。下記のVisual Studio Marketplaceで拡張ツールのインストーラーをダウンロードしてもいいですし、NuGetでマネージメントコンソールから

Install-Package StyleCop.MSBuild -Version 5.0.0

のように打ち込んでもインストールできます。

marketplace.visualstudio.com

初期設定だと、コメントの日本語をスペルミスとして検知したり今ひとつなところがあるので、一度簡単なサンプルで試して最適設定を探しましょう。また、警告メッセージが

GhostDoc

C#やVisual Basic.NETのXMLコメントを、Shift+Ctrl+Dで追加。その際に引数や内容からある程度の初期文字列を事前設定したり、SeeAlsoなどの追加記述を自動的に挿入する拡張機能です。こちらもVisual Studio Marketplaceからダウンロードできるので、インストールして利用できます。

marketplace.visualstudio.com

このツールですが、初期状態では追記してくれるコメントがすべて英語になっているため、日本の開発環境ではちょっと使いづらいと思います。自動追記されるメッセージはすべて設定画面から書き換えられますが、設定記法が少し難しいためなかなか思うように書き換えられないかと思います。下記のブログの方が用意してくださっている日本語設定を設定画面からインポートすることで、よく使う文章が日本語になるので、こちらも併せて利用しましょう。

blog.nextscape.net

GhostDocの日本語設定サンプル: https://blog.nextscape.net/~/media/Blog/zip/Japanese.zip?la=ja-JP

Visual Studio Code

これは今回に始まったものではないのですが、今回、ちょっとした資料や情報共有にMarkdown形式のファイルを使おうと考えているので、Markdownのエディター、プレビュー確認用に利用しようとしています。また、拡張機能の「Markdown PDF」をインストールすればそのままPDFファイルにも変換できるため、コーディング規約や各種伝達事項などもこれで資料化すれば見やすいものになるかと。