Visual Studio でコードを素早くクリーンアップしてフォーマットする方法

コードを整理整頓し、一貫性を保つことは、見た目がプロフェッショナルになるだけでなく、バ​​グの防止、共同作業の円滑化、そして最終的には時間の節約にもつながります。Visual Studioにはそのためのツールが多数組み込まれていますが、正直なところ、最初は最適なフォーマットやクリーンアップ方法を見つけるのに苦労するかもしれません。ショートカットが機能しなかったり、フォーマットが維持されなかったりすることもあります。このガイドでは、手間をかけずにコードの見栄えを良くするための実用的な方法をいくつか紹介します。便利なコマンド、メニューナビゲーションのヒント、そして場合によっては、環境によってはうまく機能するけれど、そうでない場合もある、という奇妙なトリックもいくつか紹介します。WindowsとVisual Studioは、必要以上に難しくしているからです。

Visual Studio でコードを修正または自動フォーマットする方法は?

方法1: キーボードショートカットを使用する

これは通常、最も速い方法です — もちろん、あなたの言語で使える場合ですが。C#、C++、JavaScript など、サポートされている言語のほとんどはデフォルトのショートカットを認識しますが、場合によってはオーバーライドされたり、期待どおりにトリガーされなかったりすることがあります。そのため、Visual Studio でコードファイルを開いた状態で、手早く整理したい場合は、以下の手順を実行してください。

• Visual Studio でコード ファイルを開きます。
• Ctrl + Kを押してからCtrl + Dを押すと、ドキュメント全体のフォーマットが自動的に行われます。
• 特定のチャンクだけを整理したい場合は、そのチャンクを強調表示してからCtrl + Kを押し、続けてCtrl + Fを押します。

この組み合わせは概ねうまく機能しますが、環境によっては再起動や、ツール > オプション > 環境 > キーボードでキーバインドの切り替えが必要になる場合があります。また、適切な言語サポートと拡張機能がインストールされていないと、何も機能しない場合もあります。

方法2: 保存時にフォーマットする

ショートカットを頻繁に押すのが面倒だと感じるなら、保存するたびにフォーマットしてプロセスを自動化するのが大変便利です。意識することなくコードの一貫性を保つことができます。有効化方法は以下の通りです。

1. [ツール]メニューに移動して、[オプション]を選択します。
2. [テキスト エディター] > [全般] (または新しい Visual Studio バージョンでは[コードのクリーンアップ] )に移動します。
3. [保存時にコード クリーンアップ プロファイルを実行する]というラベルの付いたボックスを見つけてチェックします。
4. お好みのプロファイル（通常は「プロファイル 1」または「プロファイル 2」 ）を選択してください。各プロファイルの動作は、「ツール」>「オプション」>「テキストエディター」>「コードスタイル」でカスタマイズできます。

これで、保存するたびにVisual Studioが起動し、プロファイルに基づいてコードが整理されます。設定によっては、最初の試行では少し不安定になるかもしれません。再起動が必要になることもありますが、少しテストすればかなり安定します。ただし、保存時の自動フォーマットは、特定のスペースやスタイル設定がある場合、少し強引になりすぎる可能性があるので、カスタムルールが崩れないように注意してください。

方法3: 書式設定ルールをカスタマイズする

コードの見た目をもっと細かくコントロールしたいですか？Visual Studioでは、インデント、スペース、中括弧の配置などを微調整できます。チームの標準に合わせたい場合や、特定のスタイルを好む場合に便利です。

1. [ツール] > [オプション]を開きます。
2. [テキストエディター] > [あなたの言語] > [コードスタイル]に移動します。
3. インデント、スペース、折り返し、または中括弧の配置の設定を、自分のスタイルに合わせて調整します。
4. 「OK」をクリックして設定を保存します。一貫性をさらに高めるには、設定を.editorconfigファイルでエクスポートすることを検討してください。このファイルはプロジェクトのルートに配置し、チーム全体にルールを適用できます。

どのルールを設定すればいいのか迷っていますか？ デフォルト設定を試してみて、コードがどのようになるかをテストしてみると、手動で調整するよりも良い結果が得られる場合があります。また、複数のプロジェクトにスタイルを適用したい場合は、.editorconfigファイルが非常に役立ちます。

方法4: コードのクリーンアップを手動で実行する

保存時の自動クリーンアップですべてがカバーされない場合や、コミット前にクリーンアップしたい場合は、「コードクリーンアップ」ボタンが役立ちます。まるでワンクリックで魔法の杖のように、書式の修正、usingの並べ替え、未使用コードの削除が行えます。

1. ツールバーのほうきアイコンをクリックするか、 Ctrl + Kを押してからCtrl + E を押します。
2. コードクリーンアッププロファイル1またはプロファイル2の実行を選択します。これらのプロファイルでは、スペース、using、スタイルの修正など、必要なクリーンアップの種類を選択します。
3. Visual Studioは設定に応じて、インデントの修正、重複または未使用のusingの削除、コードレイアウトのクリーンアップなどを行います。特に大きなファイルやプロジェクト全体を扱う場合、動作が少し遅く感じることがあります。

コミット前の素早い修正や、レビュー後の新しいコードベースに最適です。何か問題がある場合は、プロファイル設定を再確認するか、 「ツール」>「オプション」でルールを調整してください。

方法5：Macでのフォーマット

Visual Studio for Mac を使用している場合、キーボード ショートカットは少し異なりますが、概念は似ています。

1. コード ファイルを開きます。
2. [編集] > [詳細設定] > [ドキュメントのフォーマット]に移動します。
3. または、⌥ + ⌘ + Lを押します。

このコマンドは、現在の言語設定に基づいて、コードの位置を揃え、スペースをうまく空けます。理由は定かではありませんが、Macのショートカットは信頼性が低い場合や、再割り当てが必要な場合がありますので、注意してください。また、Macでは、外観を微調整したり、サードパーティ製の拡張機能を使用してより多くのスタイルオプションを利用したりすることもできます。ローカライズ版でメニュー項目がおかしくなる場合は、言語インターフェースの変更方法を学ぶと役立ちます。

よくある質問