C# Advent Calendar 2015の12月20日の記事になります。遅刻してすみませんすみません。
みなさん、Code整形していますか？
VS2015となってCode Aware Libraryが利用できることになったことにより楽にいろんなコーディングを行うことができるようになりました。
ただ、Code Aware Libraryで作成されるコードはあくまで補助のため、ちょっと気を抜くとすぐに可読性の低いコードになってしまいます。
つまり、コードを保守性の高い状態を保つためには、当たり前ではありますが開発者が意志をもってコーディングする必要があります。
とはいえ、複雑なプログラミングを迅速に行う必要がある昨今、開発者の力だけで可読性の高いコードを保つのもそれなりに骨が折れる作業です。
そんな場合にちょっとした補助をしてくれるのがCodeMaidです。
思っていたより知られていない機能拡張のようですので、簡単ですがマニュアルを翻訳・補足説明を掲載しておきます。
インストール
CodeMaidはVisual Studioの[ツール]→[拡張機能と更新プログラム]から「CodeMaid」で検索すると見つかりますので、そこからインストールできます。
CodeMaidがインストールされるとメインメニューに[CodeMaid]が追加されるほか、ソースコード上で右クリックしたり、ソリューションエクスプローラーでソースコードを右クリックしたりすることでコンテキストメニューが表示されます。
どんな機能がある？
それでは具体的な機能についてみてみましょう。
Code Cleaning
Code Cleaningでは指定されたコード内をクリーニングしてくれます。具体的には
- 未使用のusingを削除
- usingの並びをソート
- 未定義のアクセス修飾子を追加
- 空のRegionを削除
- 空行を追加
- コードブロック内の不要な空行の削除
- VSの書式設定を実行
- 連続した空行の削除
- 行末の空行を削除
- endregionタグの更新(regionタグと同じ内容を追記してくれる)
整形前
整形後
Code Digging
C#やC++のコードの階層を可視化し、コード全体の見通しをよく確認することができます。
可視化された一覧はソートしたり、絞り込みを行ったり、マウスのドラッグ操作によって位置の入れ替えを行ったりできます。
Comment Formatting
XMLコメントのタグ位置を整形します。
整形前
整形後
Joining
複数行にわたるコードを１行にまとめます。
整形前
整形後
Sorting
コードを選択してハイライトされた行をソートします。
整形前
整形後
Finding
編集中のファイルがソリューションエクスプローラーの中から検索します。
コードを開いた状態でメニューを選択
ファイルが見つかる
Collapsing
ソリューションエクスプローラ内のプロジェクトやフォルダーなどのノードをまとめて閉じてくれます。
ソリューションエクスプローラの閉じたい場所でCtrl+Mに続けて-を押下すると…。
閉じます。
Progressing
Visual Basicのビルド進捗状況の表示をおこなってくれます。
Toggling
ソースコードのタブで右クリックのコンテキストメニューから[Read-Only Toggle]をクリックするとソースコードをReadOnlyにします。
Read-Onlyのタブだけまとめて閉じることもできます。
Remove Regions
選択中のRegionや現在のカーソル行にあるｒRegion、全Regionを削除します。
Configuring
もちろん、これらの整形機能はCodeMaidの設定ダイアログで有効化・無効化できます。
慣れるととても便利なので、是非活用してみてください！