ことれいのもり

【PHP】コーディング規約に沿った命名ルールまとめ

はじめに

PHPの学習をしていると、「関数名はキャメルケースで書くの?」「変数名はパスカルケース?」と迷うことがよくあります。

実は、これらはコーディング規約として決められています。

しかし、公式の規約は内容が多く、毎回確認するのは大変です。


そこで今回は、学習中に迷わないようにするために、コーディング規約に書かれている内容と、一般的に使われている命名ルールをあわせて整理しました。

命名ルールで悩んでいる方の参考になると思います!

前提

この記事では、PHP-FIGというコーディング規約を参考にしています。


チーム開発を行なっている場合は、その中のルールに従うのが基本です。

しかし、個人開発や学習中の人にとっては、「自由にすれば良い」と言われても困るはずです。

そのような方は今回まとめたルールを参考にしてみてください!

コーディング規約に準拠した命名ルール

それでは具体的に命名ルールを見ていきましょう。

コーディング規約は、

  • クラス名
  • クラス定数
  • メソッド名

の命名ルールが書かれています。

しかし、変数名・クラスプロパティは書かれていません。

そのため、一般的に認知されている記法を調べたので、それに沿って紹介します。

クラス名

StudlyCaps、またはPascalCase(パスカルケース)という書き方で命名します。

単語の先頭を大文字にして、空白は入れません。

class MyClass
{

}

クラス定数

全て大文字で、単語の区切りをアンダースコアにして命名します。

const LOOP_COUNT = 4;

クラスプロパティ・変数名

camelCase(キャメルケース)という書き方で命名します。

最初の単語の先頭は小文字で、2番目以降の先頭は全て大文字にします。

空白は入れません。

// クラスプロパティ
public $userEmail = "xxx@gmail.com";

// ローカル変数
$userEmail = "xxx@gmail.com";

メソッド名(関数)

camelCase(キャメルケース)という書き方で命名します。

最初の単語の先頭は小文字で、2番目以降の先頭は全て大文字にします。

空白は入れません。

function getUserName()
{

}

まとめ

ここまでの書き方をまとめると、以下のようになります。

class MyClass
{
    const LOOP_COUNT = 4;

    public $userEmail = "xxx@gmail.com";

    function getUserEmail()
    {
        return $this->userEmail;
    }
}

おわりに

この記事では、コーディング規約に沿って命名ルールをまとめました。

私自身、命名ルールについて毎回悩んでいたので、同じような方の参考になれば良いなと思っています。

命名ルールを統一するとコード全体が見やすくなるので、意識してみてはいかがでしょうか?