PHPのコーディングルールについて
2022/03/07
こんにちは!バックエンドエンジニアの米岡です。
社内ホームページリニューアルに伴って、社内コラムを始めることになりました。
毎週交代で自由なテーマで記述していきます。
第一回のテーマとして挙げるのは
「PHPのコーディングルールについて」です。
WEB開発では主にPHPという言語が使われます。
開発を行うにあたってよく問題となるのが
・ソースコードの書き方が各々バラバラ
・ソースコードが汚い
などがあります。
そのせいで工数が増えてしまう事もよくあります。
起こる理由としましては、PHPはバックエンドのサーバー側のプログラムという事もあり
基本的にブラウザから確認する事が出来ません。
クライアントの目に留まることもありません。
正直に言うと
「動いていればなんでもいい」
部分だからです。
なのでソースコードの綺麗さは基本的には強制されるものではなく、各々の意識、プロジェクトのルールなどで維持していくものになります。
HTML、CSS、JSなどのフロントエンドの場合は、ソースコードの綺麗さが検索エンジンに評価されますので
バックエンドよりはソースコードを綺麗に書くという意識が高いように思います。
前置きが長くなってしまいましたが
・ソースコードを綺麗にする
という事を意識するにあたって、PHPには公式が出しているコーディングルールというものがあります。
PSRという名称なのですが、現在はPSR1から18まであり、バージョンに合わせて随時更新されています。
メジャーなPSR-2の一部を抜粋すると
文字数
1行にコーディングする文字数に厳しい制限は設けない。
1行中の文字数限界値は120文字とし、エディターで自動チェックできる場合はそこで警告を出すべきではあるが、あくまでもソフトな限界値なので、エラーは出さない。
とはいえ、1行の文字数は80文字を超えない。それよりも長い場合は、複数行に分割して記述する。
インデント
インデントはタブではなく、4つのスペースを使用する。
if/elseif/else
ifの書式は以下の通り。
if ($foo) {
} elseif ($bar) {
} else {
}
括弧、スペース、および中括弧の配置に注意する。
elseとelseifは前のボディの閉じた終了波括弧と同じ行にある。
全ての制御キーワードが単一のように見えるように、else if ではなく elseif を使う。
このように、読んでみると意外に簡単な言葉で記述されています。
細かい点ですがこういうのも意識してみるとさらに技術の向上になるのかなと思いました。
是非プログラムを組む際はこのような点も意識してみるのはどうでしょうか?
----------------------------------------------------------------------
株式会社AQUARIZE
〒531-0072
大阪市北区豊崎3-6-8 TOビル404
電話番号 : 06-7777-2927
税理士の業務に合ったシステム
----------------------------------------------------------------------