IT業界のすみっこ暮らし

ふと気がついたときの記録

CodeMaid(VS拡張機能のコード整形ツール)

公式サイト
CodeMaid | An open source visual studio extension to cleanup, dig through and simplify our code

ダウンロード
CodeMaid - Visual Studio Marketplace

参考になりそうなサイト
moriblog.kit-eng.com

導入後はVisual StudioのCODEMAIDからメニューを確認できる。 「Configuration」から詳細設定を行うことが可能。

クリーンアップ可能なファイルタイプの種類
C#C++、F#、VBXAMLXML、HTML、CSS、LESS、JavaScript、TypeScript) f:id:papamau:20161228145708p:plain

以下、メインとなる設定まとめ。

Visual Studioに関する設定

f:id:papamau:20161228143349p:plain

設定 詳細
Run format document フォーマットドキュメント実行する
Run remove unused using statements 未使用宣言文を削除する
Skip during automatic cleanup on save ファイル保存時に自動整形を行わない
Run sort using statements 宣言の並び替えを行う
Skip during automatic cleanup on save ファイル保存時に自動整形を行わない

生成に関する設定

f:id:papamau:20161228144013p:plain

設定 詳細
Insert blank line padding befor 前に改行を入れる
Insert blank line padding between 前後に改行を入れる
Insert blank line padding after 後に改行を入れる
Insert blank space before 前に空白スペースを入れる
Insert explicit access modifiers on 明示的なアクセス修飾子を付ける

削除に関する設定

f:id:papamau:20161228144429p:plain

設定 詳細
Remove blank lines 空行を削除する
Remove blank spaces 空白スペースを削除する
Remove end of file trailing new line ファイルの最後の空行を削除する
Remove end of line whitespace 行の後尾につく空白スペースを削除する
Remove multiple consecutive blank lines 複数の連続した空行を削除する

更新に関する設定

f:id:papamau:20161228144808p:plain

設定 詳細
Update accessors to both be single-line or multi-line 一行、若しくは複数行のスコープ(ex)private/public..)Iを自動更新する
Update #endregion tags with region name #endregionタグはregion名とセットになるように更新する
Update single line methods by placing braces on separate lines 一行に宣言されたメソッドを複数行に更新する

コメントに関する設定

f:id:papamau:20161228145051p:plain

まとめ

チーム作業の場合、Import/Export機能でみんなで同じ設定を共有した方がおすすめ。


以上