とぎぷろべい

包丁研ぎとプログラミングと米国株投資についてのなんやかんや

PHPのコーディング規約について

f:id:feci:20210727001932j:plain

PHP7

 

PHPのコーディング規約について。

 

PHPには他のプログラミング言語と同様に、コーディング上の規約があります。

この規約を守らなくてもスクリプトとしては動くのですが、自分も他人も読みやすいし管理しやすいコードを書こうということで、プログラマーが守るべき努力義務的なルール集があります。

これがコーディング規約です。

 

PHPのコーディング規約で有名なものにはPSRというものがあります。

PSRには2019年時点でPSR-1からPSR-19までの19個もあるらしいですが、今回は基本的な部分のPSR-1とPSR-2からコーディング規約を抜粋してきました。

 

 

〇PSR-1からの抜粋

  • PHPコードのタグは「<?php」か 「<?=」のどちらかのみ使用可能。
  • 文字コードUTF-8(BOM無し)のみ使用可能。
  • シンボルを宣言するためのファイルと副作用のある処理を実行するためのファイルは分ける。
  • クラス名はStudlyCaps記法で定義する。
  • クラス定数の名称はすべて大文字で記述し、なおかつ区切り文字にはアンダースコアを用いて定義する。
  • メソッド名はcamelCase記法で定義する。

 

シンボル:クラス、関数、定数などのことです。

副作用のある処理:出力の生成、ini設定の変更などのことです。

StudlyCaps記法:単語の先頭文字を大文字で表記する記法です。
StudlyCaps記法:各単語を空白で区切ってはいけません。

camelCase記法:2つ目の単語から頭文字をすべて大文字にする記法。
camelCase記法:各単語を空白で区切ってはいけません。

 

 

〇PSR-2からの抜粋

  • インデント:半角スペースは4つです(タブの使用は不可)。
  • 1行の長さ:長くても80~120文字以内に収める努力をしてください。
  • 名前空間名前空間の宣言後には空行を入れます。
  • アクセス修飾子:すべてのプロパティとメソッドで定義してください。
  • 制御構造:①キーワードの後ろの波括弧{との間に1つスペースを入れる。
    制御構造:②メソッドや関数の呼び出し丸括弧(の前にはスペース入れない。
    制御構造:③開始の{は同じ行に記述して閉じの}は最後の文の次の行に記述する。
    制御構造:④開始{の後ろと閉じる}の前にはスペースは入れない。

 

 

上記のルールを守ってコーディングをしていくと、なんかみんなハッピーになれるらしいです。

がんばって履行していきましょう。

 

 

以上です。