PyCharm 2020.2ヘルプ

コードスタイルの構成

特定のコーディングガイドラインが企業内に存在する場合は、ソースコードを作成する際に、このガイドラインに従わなければなりません。PyCharmは、必要なコードスタイルを維持できます。

コードスタイルは、プロジェクトレベルIDEレベル(グローバル)で定義されます。

  • プロジェクトレベルでは、設定はプロジェクトスキームにグループ化されます。これは事前定義されており、太字でマークされています。プロジェクトスタイルスキームは現在のプロジェクトにのみ適用されます。

    IDE にコピーコマンドを使用して、プロジェクトスキームをIDEレベルにコピーすることができます。

  • IDEレベルでは、設定は事前定義されたデフォルトスキーム(太字で表示)、および複製コマンドによってユーザーが作成したその他のスキーム(プレーンテキストとして表示)にグループ化されています。グローバル設定は、ユーザーがプロジェクトでコードスタイル設定を保持して共有したくない場合に使用されます。

    プロジェクトにコピーコマンドを使用して、IDEスキームを現在のプロジェクトにコピーできます。

言語のコードスタイルを設定する

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、エディター | コード・スタイルに進み、プログラミング言語のページを開きます。

  2. 選択した言語のカスタムコーディングスタイルのベースとして使用するコードスタイルスキームを選択します。

  3. 選択した言語ページのタブをブラウズし、その言語スタイルの設定を行います。

他の言語からコードスタイル設定をコピーする

ほとんどのサポートされている言語では、他の言語やフレームワークのコードスタイル設定をコピーできます。

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、エディター | コード・スタイルに進み、プログラミング言語のページを開きます。

  2. 表示されるリストから、コードスタイルをコピーする言語を選択します。

    Set code style

EditorConfigを使用してディレクトリレベルでコードスタイルを管理する

PyCharmでは、EditorConfig(英語)サポート(設定/環境設定ダイアログ Ctrl+Alt+Sでデフォルトで有効になっています)を使用して、ファイルの個々のセットのすべてのコードスタイル設定を管理できます。コードスタイルを定義するファイルが含まれるルートディレクトリに.editorconfigファイルを配置するだけです。プロジェクト内に必要な数の.editorconfigファイルを含めることができるため、さまざまなモジュールにさまざまなスタイルを指定できます。

.editorconfigファイルのすべてのオプションは、現在のプロジェクトコードスタイルの最上位にあるすべてのサブディレクトリと同様に、それが存在するディレクトリに適用されます。 .editorconfigで何も定義されていない場合は、プロジェクト設定から取得されます。

.editorconfigファイルのすべてのオプションは、以下のカテゴリに分類されます。

  • indent_size , indent_styleなどの標準オプションこれらのオプションには、ドメイン固有のプレフィックスはありません。

  • ij_ という接頭辞を持ち、すべての言語に適用可能な一般的なIntelliJオプション

    • ij_visual_guides

    • ij_formatter_off_tag

    • ij_formatter_on_tag

    • ij_formatter_tags_enabled

    • ij_wrap_on_typing

    • ij_continuation_indent_size

    • ij_smart_tabs

  • 多くの(全部ではない)言語でサポートされている共通のIntelliJオプション。それらは ij_any_brace_styleのように、ij_any プレフィックスで始まります。

  • <lang> は言語ドメインID(通常は小文字の言語名)である ij_<lang>_ 接頭部で始まるIntelliJ言語固有のオプション、たとえば ij_java_blank_lines_after_imports

.editorconfigファイルを追加する

  1. プロジェクトビューで、コードスタイルを定義するファイルを含むソースディレクトリを右クリックして、コンテキストメニューから新規 | EditorConfigを選択します。

  2. PyCharmがスタブを作成するように定義するプロパティを選択するか、必要なプロパティを手動で追加するにはすべてのチェックボックスを空白のままにします。

  3. コードスタイル設定の変更が実際のソースファイルにどのように影響するかをプレビューするには、.editorconfigファイルのガターで the eye icon をクリックし、影響を受けるソースファイルを選択します。プレビューが右側に開きます。

    editorconfig preview

    プレビューペインを変更して、ソースコードに不要な変更を加えることを気にせずに構成の変更がどのように反映されるかを試すことができます。これらの変更はすべて.editorconfigファイルを閉じると破棄されます。

最終更新日: 2020年8月19日