Skip to content

clang formatの設定方法

KakinokiKanta edited this page May 12, 2023 · 1 revision

ClangFormatとは

ClangFormat (クラン・フォーマット) とは、C/C++/C#/Java/JavaScriptなどのソースコードを整形 (フォーマット) するツールです。

「.clang-format」というファイルに、詳細な書式設定を記述し、この書式設定に従ってソースコードをフォーマットします。

設定方法

VSCodeの場合

まず,C++のプラグインをインストールします.

https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools

上記のURLを開き,インストールをクリックするとVSCodeのインストール画面に移ります.

スクリーンショット1 2021-05-18

下図の青いボタンのインストールをクリックすると,プラグインがインストールされます.

スクリーンショット2 2021-05-18

プラグインをインストールできたら,clang-format設定を行います.
VSCodeのショートカットキーctrl + ,(Macの場合command + ,)で設定画面を開き,右上にあるアイコンをクリックします.

スクリーンショット2 2021-05-18

settings.jsonが開かれるので,以下を追記してください.

// ワークスペース内の.clang-formatファイルを探してそのスタイルを適用する.存在しない場合,C_Cpp.clang_format_fallbackStyleの設定が適用される.
"C_Cpp.clang_format_style": "file",
// 保存時に自動整形
"editor.formatOnSave": true,
// エディタで区切りを入力後に自動でフォーマットをするかどうか
"editor.formatOnType": true

これで保存時に自動整形してくれるはずです.(Ctrl + s または Command + sで保存)

整形しない場合は,VSCodeを再起動してください.

この設定は,プロジェクト内の.clang-formatファイルにしたがって整形します.

Vimの場合

まず,clang-formatをインストールします.

Ubuntuの場合は以下を実行.

$ sudo apt install clang-format

macOSの場合は以下を実行.

$ brew install clang-format

次に,vimプラグインをインストールします.
自分の使っているプラグインマネージャーに合わせて,kana/vim-operator-userhysd/vim-clang-formatをインストールしてください.ここでは,プラグインマネージャーにVundleを用いた説明をします.

参考:Vimにプラグインをインストールする入れ方【Vundleで管理・使い方】

まず,以下のコマンドでvimの設定ファイルを開きます.

$ vim ~/.vimrc

設定ファイルを開いたら,以下を追記してください.

Plugin 'kana/vim-operator-use'
Plugin 'rhysd/vim-clang-format'

追記したら,ノーマルモードで:PluginInstallを入力します.これでプラグインのインストールが完了です.

最後に,同じく設定ファイルに,以下のような自動フォーマットの設定を追記します.

autocmd FileType cpp ClangFormatAutoEnable

これで,:wで保存したときに自動整形してくれるはずです.


参考資料

C/C++ for Visual Studio Code (Preview)

vscodeのC++用コード整形設定(clang-formatの設定)

VisualStudioCodeに自動整形機能があった

C言語のソースコードをvimで自動整形する