RubyMine 2019.3ヘルプ

コードスタイルの設定

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Set code style

コードスタイル設定のコピーを作成する

あらかじめ定義されているものとは異なるコードスタイルを定義できます。これらのコードスタイルスキームは、ユーザホームディレクトリーの config/codestyles フォルダーにあるXMLファイルに格納されています。作成したコピーをコードスタイルの変更およびエクスポートに使用できます。

プロジェクト以外のコードスタイルスキームを選択すると、このコードスタイルがプロジェクト用に保存されます。プロジェクトごとにグローバル(IDE)コードスタイルを割り当てることができます。

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、エディター | コード・スタイルに移動します。

  2. スキームリストから目的のスキームを選択して、the Scheme Settings iconをクリックします。

  3. 次のいずれかのオプションを選択します。

    • IDE にコピー - 選択したスキームをグローバルレベルで保存するには、このオプションを選択します。

      RubyMineはRubyMineホームディレクトリー下の config/codestyles/<code_style_name>.xml ファイルに指定した名前の新しいコードスタイルを保存します。

    • プロジェクトにコピー - 選択したスキームをプロジェクトレベルで保存するには、このオプションを選択します。

      選択したコードスタイルは、ファイル codeStyleSettings.xml.idea ディレクトリーに保存されます。

    • 複製 - 選択したスキームのコピーを作成して同じレベルに保存するには、このオプションを選択します。

  4. スキームフィールドに新しいスキームの名前を入力し、Enter を押して変更を保存します。

コードスタイルスキームを管理する

  1. コードスタイルページで、目的のスキームを選択して manage profilesをクリックします。

  2. 次のいずれかのオプションを選択します。

    • 名前変更 - 選択したスキームの名前を変更するには、このオプションを選択します。

    • エクスポート - このオプションを選択して、コードスタイル設定を目的の場所にエクスポートします。

    • インポート - RubyMine XMLコードスタイル設定、JSCS設定ファイル、またはEclipse XMLプロファイルをインポートするには、このオプションを選択します。

  3. スキームフィールドに新しいスキームの名前を入力し、Enter を押して変更を保存します。

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

RubyMineでは、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. RubyMineがスタブを作成するように定義するプロパティーを選択するか、必要なプロパティーを手動で追加するにはすべてのチェックボックスを空白のままにします。

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

    editorconfig preview

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

最終更新日: 2019年12月5日

関連ページ:

コード・スタイル

WindowsとLinux用のmacOS用スキーム:この領域では、コードスタイルスキームを選択し、必要に応じて変更します。コードスタイルスキームの設定は、RubyMineがコードを生成、リファクタリング、または再フォーマットするたびに自動的に適用されます。コードスタイルはプロジェクトレベルとIDEレ...

プラグイン

WindowsとLinux用のmacOS用このページを使用してプラグインを管理します。プラグインリポジトリの閲覧、プラグインのインストール、削除、有効化、無効化、および更新を行います。主なコントロール:マーケットプレースこのタブを使用して、JetBrainsプラグインリポジトリからプラグインをブラウ...

プラグインを管理する

プラグインはRubyMineのコア機能を拡張します。バージョン管理システム、アプリケーションサーバー、その他のツールとの統合を提供、さまざまな言語およびフレームワークに対するコーディング支援サポートを追加する、ショートカットヒント、ライブプレビュー、ファイルウォッチャーなどを使用して、生産性をBoo...

行セパレーター

RubyMineを使用すると、新しく作成したファイルに行セパレーター(行末)を設定したり、既存のファイルの行セパレータースタイルを変更したりできます。新しく作成されたファイルの行区切りの設定設定/環境設定ダイアログ で、に移動します。行セパレーターリストから、目的の行区切りスタイルを選択します。現在...