サーチ…


プロジェクトのコードスタイルを定義する

PhpStormは、ベストプラクティスと一般的な標準に基づいて大量の言語のコードスタイリングのデフォルト設定を提供します。しかし、PhpStorm設定> エディタ > コードスタイルでは、プロジェクトごとに言語ごとのスタイルをカスタマイズできます。

コードスタイルの設定

スキーム

スキームは、コードスタイルのガイドラインと設定の集合です。プロジェクトのスキームを選択すると、そのスキームが即座に適用されます。また、プロジェクトを開いている間だけ利用可能なProjectスキームもあります。 Projectスキームは、ガイドラインを一般的なユーザー設定に保存するのではなく、プロジェクト独自の設定に保存します。

[Manage ]ボタンをクリックすると、新しいスキームを追加して、新しいコードスタイルガイドラインを素早く設定できます。また、スキームを友人や同僚と共有したい場合には、 Manageボックスを使用してスキームをエクスポートまたはインポートすることができます。

コードスタイル管理ボックス

特定の言語のスタイルを変更する

特定の言語のコードスタイル設定を変更するには、サイドバーで使用可能な言語をクリックします。言語ごとに異なる設定ページが表示されます。

たとえば、PHP言語には、タブとスペース、中括弧、またはPHPドキュメントの設定があります。

PHPのコードスタイル

それぞれの設定が何を意味するのかを知りたければ、公式文書でそれらを見ることができます。

PhpStorm 2016以降のコードスタイルのドキュメント

複数のチームメンバーにまたがってプロジェクトに指定されたコードスタイルを強制する

現在のところ、チーム全体にコードスタイルガイドラインを実際に適用するワンクリックボタン方式はありませんが、特定のコードスタイルが製品に適用されることを確認する方法は2つあります。

PhpStormコードスタイルスキームのインポート

最初の簡単な解決策は、自分のPhpStormインスタンスにコードスタイルスキームを設定し、そのスキームをポータブルドライブまたはネットワークドライブにエクスポートし、すべての開発マシンでスキームをインポートすることです。
これにより、開発者はキーボードショートカットのCmd + Shift + L (MacOS)またはCtl + Alt + L (Windows / Linux)を使用して自動的に完全なソースコードをフォーマットできます。

詳細については、次のドキュメントを参照してください。

PhpStorm 2016以降のソースコードの再フォーマット

短所
残念ながら、開発者が実際にコードを再フォーマットしたかどうかを確認する方法はありません。開発者は、再フォーマットの世話をする約束に頼らざるを得ません。

CIサーバーによる自動コードフォーマットチェック

ソースコードのフォーマットを制御するための非常に厳密な方法は、ソースコードがあらかじめ定義されたコードスタイルと一致するかどうかを確認できるJenkinsのようなcontinuos統合サーバーを実装することです。

開発者が自分の開発ブランチの新機能を開発し、その変更をメインリポジトリにプッシュしたいとしましょう。最初に、彼は自分のブランチに変更をプッシュし、新しい機能がCIサーバーによってチェックされます。コードが正しくフォーマットされていないため、チェックが失敗した場合、開発者に通知され、問題を修正できるようになります。

さまざまなインテグレーションサーバーでコード品質とフォーマットチェックを設定する方法にはさまざまな方法があり、対応するタグでチェックを行うようにサーバーを設定する方法を説明します。

PSR-2のような定義済みの標準からコードスタイルを設定する

PhpStormには、 PSR-2のような一般的なコードスタイルガイドラインと標準に基づいた、あらかじめ定義された多くの言語スキームが用意されています。コードスタイル設定ページには、これらの標準をインポートして現在の設定として設定できる隠し機能があります。これを行うには、左側のパネルでコーディング言語を選択するだけです。それから、右上に小さなリンクがあります。

このリンクPhpStormをクリックすると、あなたが事前に定義されたスタイル]タブの下に事前に定義された標準から選ぶことができ、小さなポップアップを紹介します。

PhpStormからスタイルを設定



Modified text is an extract of the original Stack Overflow Documentation
ライセンスを受けた CC BY-SA 3.0
所属していない Stack Overflow