コード整形のために積極的に利用したい拡張機能 CodeMaid
Visual Studio でのコーディング時の悩み
C# での開発を行っていると、Visual Studio がいろいろな機能を持っていてデフォルトでもかなり使いやすいと感じています。(atom での開発と比較して)
しかしながら、atom のパッケージで実現できていた機能で、Visual Studio ではデフォルトではできないこともそれなりにあります。
そのうちの一つがコードの整形でした。
Visual Studio には拡張機能がある
しかし、Visual Studio にも、atom のパッケージと同じように、機能を組込むことができます。
それが「拡張機能」です。
(その他、Nugetもありますが)
この拡張機能のひとつとして、コード整形の 「CodeMaid」というものがあります。
CodeMaid - Visual Studio Marketplace
CodeMaid のインストール方法
インストールは非常に簡単です。
Visual Studio の [ツール]→[拡張機能と更新プログラム]を選択し、「CodeMaid」を検索します。
すると、CodeMaidが表示されますので、[インストール]ボタンからインストールするだけです。
CodeMaid の機能
- Code Cleaning
- Code Digging
- Code Reorganizing
- Comment Formatting
- Joining
- Finding
- Sorting
- Collapsing
- Progressing
- Configuring
- Switching
- Toggling
色々ありますが、コード整形を自動で行ってくれる機能と、それ以外の付帯機能と考えていいと思います。
CodeMaid の使い方
Visual Studio のコードエディタ上で右クリックすると、[CodeMaid]が追加されています。
その中の [Cleanup Active Document] を選択することで、開いているソースコードの整形が行われます。
具体的な整形内容ですが、
- Remove unused using statements (不要な using の削除)
- Sort using statements (using の並び替え)
- Add unspecified access modifiers (アクセス修飾子の追加)
- Remove empty regions (空の region の削除)
- Add blank line padding (空行の追加)
- Remove blank lines next to braces (中括弧の次の空行を削除)
- Run Visual Studio formatting (Visual Studio のフォーマット)
- Remove consecutive blank lines (連続した空行の削除)
- Remove end of line whitespace (スペースのトリム)
- Update endregion tags (endregion タグの更新)
となっています。
具体的にどうなるのかは、公式ページがわかりやすいです。(英語ですが、わからなくても画面キャプチャだけでわかります。)
http://www.codemaid.net/documentation/#cleaning
何故使うか
これを使うことで、一定のルールが自動で施されるようになり、コードの可読性が上がります。
また、チーム開発でのソースコードレビューで些末な指摘から開放されます。
もちろん、CodeMaid はあくまでアシスト役として、静的コード解析・ソースコードレビューと組み合わせることが必要だとは思いますが、自動的に修正できることはこういったツールに任せて、人間はもっと根本的なコーディングに時間を使ったほうが、生産性の向上に寄与します。
このような補助をうまく使うことで、楽しくコーディングしたいものです。
