C++ の連鎖メソッド呼び出しを Clang 形式のインデントに揃える方法

完璧なインデントのための Clang 形式をマスターする

すべての開発者は、特に作業する場合に、クリーンで読みやすいコードを好みます。 連鎖したメソッド呼び出し C++で。しかし、私たちは皆、次のようなツールに遭遇したことがあります。 クラン形式 私たちが好む方法でコードを整列させることを拒否することがあります。よくある課題の 1 つは、開始関数ではなく、前の行に対して連鎖メソッドのインデントを美しく揃えることです。

ビルダー パターンを使用してオブジェクトを構築していると想像してください。次のようなきちんとした出力が必要です。

auto foo = FooBuilder()
.WithSomething()
.WithSomethingElse()
。建てる（）;

しかし、clang-format はメソッドを右端に押し込み、クリーンなコードを引き延ばされた混乱に変えることを主張します。それまで整理されていた線が突然矛盾して見えるようになり、視覚的な流れが崩れてしまいます。イライラしますよね？ 🤯

API サービスのリファクタリング中にこの問題に遭遇したことを覚えています。完全に整列したメソッド呼び出しは階段に似たものになり、各行がさらに右に押し出されます。コードレビューが難しくなり、目が疲れました。この記事では、コードのスタイリッシュさと読みやすさを維持するために、連鎖呼び出しの Clang 形式のインデントの制御を取り戻すための実践的な洞察を共有します。 🛠️

# Step 1: Create a .clang-format file in your project root
# Step 2: Add the following configuration to control indentation
BasedOnStyle: Google
ContinuationIndentWidth: 4
AlignAfterOpenBracket: false
AllowShortFunctionsOnASingleLine: Empty
BreakBeforeBraces: Attach
# Align method calls relative to the previous line
ColumnLimit: 0 # Disables column wrapping
# Save and format your code

// Use clang-format directives to skip specific code regions
auto foo = FooBuilder()
    // clang-format off
    .WithSomething()
    .WithSomethingElse()
    .Build();
    // clang-format on
// clang-format will ignore indentation inside the marked section
// Useful for one-off adjustments without changing global settings
// Combine with other tools for consistency

import re
# Python script to reformat chained method calls
def adjust_indentation(input_file, output_file):
    with open(input_file, 'r') as f:
        lines = f.readlines()
    with open(output_file, 'w') as f_out:
        for line in lines:
            if re.search(r'^\s*\..*', line):
                f_out.write('    ' + line.strip() + '\n')
            else:
                f_out.write(line)
# Usage: adjust_indentation('input.cpp', 'output.cpp')

#include <gtest/gtest.h>
// Example function to validate chaining format
TEST(IndentationTest, ChainedMethods) {
    std::string expected =
        "auto foo = FooBuilder()\n"
        "    .WithSomething()\n"
        "    .WithSomethingElse()\n"
        "    .Build();";
    std::string actual = FooBuilder()
        .WithSomething()
        .WithSomethingElse()
        .Build();
    ASSERT_EQ(expected, actual);
}

正確なメソッドチェーンのためのclang形式の微調整

上記で提供されたスクリプトでは、調整方法を検討しました。 クラン形式 C++ で読みやすくクリーンなメソッド呼び出しの連鎖を維持します。この問題は、clang-format がメソッド呼び出しを前の行ではなく最初の関数呼び出しを基準にして配置されるために発生します。これを解決するために、次のような特定のコマンドを使用しました。 継続インデント幅、次のようなディレクティブ Clang フォーマットのオフ/オン、および Python で書かれた後処理スクリプト。各メソッドは、開発者に最大限の柔軟性を確保するために、わずかに異なるユースケースを対象としています。

最初の解決策には、 .clang-format ファイル。このファイルを使用すると、開発者は C++ プロジェクトの書式設定ルールをカスタマイズできます。主な設定には以下が含まれます 継続インデント幅、行継続のためのスペースの数を指定します。 開いたブラケットの後に整列これにより、clang-format が括弧の後にコードを不必要に配置するのを防ぎます。たとえば、設定 列制限: 0 改行を無効にし、チェーンされたメソッドが正しく整列され、視覚的に魅力的な状態を維持できるようにします。

2 番目のアプローチには、次のような手動制御が含まれます。 Clang フォーマットのオフ/オン 指令。これらは、自動フォーマットを一時的に無効にするインライン コメントです。これらのディレクティブをメソッド チェーンの前後に戦略的に配置することで、開発者はインデントを完全に制御できるようになります。たとえば、メソッド呼び出しの前に「//clang-format off」を挿入すると、clang-format が干渉しなくなり、グローバル設定が理想的ではない場合に実用的な 1 回限りの解決策になります。これは、他の人が異なる書式ルールを持っている可能性がある共同作業環境で特に役立ちます。 ✨

最後に、clang-format の実行後にフォーマットの問題を後処理するための Python スクリプトを導入しました。このスクリプトは、連鎖されたメソッド呼び出しをスキャンし、前の行に対してスペースを追加することでそのインデントを調整します。正規表現を使用して、スクリプトはドットで始まる行 (例: ".WithSomething()") を識別し、一貫したインデントを適用します。このような自動化は、手動介入に時間がかかる大規模なコードベースで特に役立ちます。さらに、フォーマットされたコードが意図したスタイルと一致することを検証するために、Google Test で書かれた単体テストを組み込み、複数の環境にわたる堅牢性を確保しました。 🛠️

Clang-format を使用して連鎖メソッドのインデントを完成させる

使用時に見落とされがちな側面の 1 つ クラン形式 複雑なコードベースでの連鎖メソッド呼び出しとの相互作用です。ビルダーや流暢な API を扱う場合、適切な配置により可読性が向上します。開発者は、メソッド チェーンが前の行に対して正確に位置合わせされることを望んでいますが、clang-format のデフォルトの動作では、メソッド チェーンが基本メソッドまたは関数呼び出しの下に位置合わせされます。これにより、コードが乱雑で読みにくくなり、メソッド チェーンの論理フローが崩れる可能性があります。

これに対処するには、その方法を理解することが重要です クラン形式 コードを処理します。デフォルトでは、次のようなパラメータに依存します。 継続インデント幅 そして 開いたブラケットの後に整列。ただし、これらの構成では複数回線の通話を完全に制御できない場合があります。たとえば、設定 0 に 0 自動改行は防止しますが、インデントは修正されません。細かく制御するには、次のようなディレクティブ // clang-format off そして // clang-format on コードの特定の領域での書式設定をバイパスするために戦略的に配置できます。

チーム間で一貫したフォーマットが不可欠なプロジェクトでは、後処理スクリプトやカスタム IDE 構成などのツールが必要になる場合があります。たとえば、連鎖呼び出しを検出し、インデントを再調整する Python スクリプトは、バックアップ ソリューションとして機能します。このアプローチにより、たとえ クラン形式 的を外した場合、開発者はコード変更後に目的のスタイルを自動的に適用できます。 🚀