整形

提供: RAD Studio
移動先: 案内検索

C++ オプション への移動


ツール > オプション... > 言語 > C++ > 整形

C++ 整形オプション

コード フォーマッタは、コードのレイアウトの変更に使用されます: これらは、改行の位置、中括弧の位置、インデントの量と内容などのスタイル上の選択です。

通常、これは特定のコーディング標準(一般的なもの、個人固有のもの、企業のもののいずれか)に一致させるために行われます。C++Builder は、clang-format ツールを通じてこれを実装します。

エディタにて、またはコマンドライン ツールを使用して、選択したコードやユニット全体のコードを整形します。IDE 内は、現在作業しているコードを整形するのが便利です。コマンドライン ツールは、コードのコミット時の自動整形、コードの一括整形、または同様の操作に便利です。

C++ の下のページでは、次の拡張子の C/C++ ソース コード ファイルの C++ プロジェクトで、オプションを設定するのに使用することができます。*.cpp*.cxx*.cc*.c*.hpp*.hxx*.hh*.h

整形の動作

項目 説明

[自動整形]

改行で保存または整形する際に、コードを手動または自動で整形します。選択項目は次のとおりです。

  • [自動なし] - Ctrl+D を押して手動で起動したときにのみ、コードを整形します。フォーマッタは、エディタで選択されているコードを整形するか、何も選択されていない場合にはファイル全体を整形します。
  • [保存時に整形] - ファイルの保存時にコードを整形します。
  • [改行時に整形] - 改行を追加するために Enter を押すたびにコードを整形します。

[改行の行制限で整形]

改行時に自動的に整形することを選択した場合、一旦コードがこの行数を超えると、フォーマッタは起動されず、整形は適用されません。これは、clang-format が、長いユニットを整形するときに顕著な長さの時間がかかるためにあります。デフォルトは 1000 に設定されています。

[整形スタイル]

ドロップダウン メニューをクリックすると、定義済みの整形スタイルのリストが表示されます: LLVMGoogleChromiumMozillaWebKitEmbarcadero。デフォルトは Embarcadero です。 [Custom formatting] Embarcadero、Mozilla などのデフォルト設定と同様、この設定に表示される clang-format プリセットを作成したり、プロジェクトごとに整形設定を上書きすることができます。 [Per-project overrides] clang-format 規約では、プロジェクトは自分の整形スタイルを、ソース フォルダ内の .clang-format 整形設定ファイル(ファイル名がドット始まりである点に注意)で指定します。IDE は、プロジェクト ソースに関連づけられている .clang-format 設定ファイルを見つけると、コードを整形する際にその書式を使用します。 設定ファイルが見つからなければ、この設定で定義されているスタイルを、フォールバックとして使用します。これはつまり、IDE の設定は、プロジェクト単位ベースで上書きされない場合に限り使用され、IDE は、提供される .clang-format ファイルの規約を使用するプロジェクト単位オーバーライドを優先することを意味します。これは、オープンソース C++ ライブラリでは一般的です。 [New IDE-wide configuration] フォーマッタ オプションが格納する新しい設定ファイルを作成し、それらをすべてのプロジェクトのフォールバックとして IDE で使用できるようにすることができます。このために、ファイルの要件は次のとおりです:

  • Formatter_*.clang-format ファイル マスクと一致する
  • RAD Studio 作業ディレクトにある: C:\Users\<username>\AppData\Roaming\Embarcadero\BDS\22.0

これにより、フォーマッタの名前は、「整形スタイル」設定のオプションとして表示されます。 既存の設定をベースにファイルを編集または作成します。設定ファイルの記述方法については、「Clang 形式のスタイル オプション」を参照してください。

メモ: 新しいファイルは、次に IDE が起動した際に、[整形スタイル]ドロップダウン メニューに表示されます。

[確認ダイアログを表示]

オンの場合、整形コマンドを実行した際、[確認]メッセージが表示されます。

整形の抑制

整形したくないコードを次のようにコメントで囲むことで、特定のセクションに対する整形を抑制することができます:

// clang-format off
Code here will not be formatted
// clang-format on

コメントで整形をオフにすると、次に「オン」コメントが現れるまで整形が止まります。コメントは、単一行形式でも(//)、複数行形式でも(/**/)使用できます。

Clang-format コマンドライン

コマンドラインでフォーマッタを起動できます。clang-format.exe と呼ばれます。Clang-format には整形設定ファイルを選択するオプションはなく、常に、ローカルの .clang-format ファイルを検索します。このため、Embarcadero 整形スタイルを使用するには、Embarcadero.clang-format を自分のソース フォルダにコピーし、.clang-format と名前を変更する必要があります。

関連項目