PHPファイル全体のフォーマット

インデントや文字コードなどのPHPファイル全体のフォーマットについてのコーディング規約です。

Outline

PHPの開始タグ

PHPの開始タグは意図しないエラーを防ぐために、必ず "<?" ではなく標準の "<?php" を使用してください。

PHPコードのみからなるファイルでは、終了タグ "?>" は決して含めてはいけません。これは必須なものではなく、終了タグを省略することで、ファイルの最後にあるスペースが出力に影響することを防ぎます。

ファイルの最後にスペースがあると、セッション処理などのHTTPリクエストの処理などがエラーになってしまいますので、終了タグ "?>" は絶対につけてはいけません。

字下げはスペース 4 文字で行います。

タブ文字は、エディタの環境によって、表示するスペース数が違ってきますので、タブ文字ではなくスペースを使用してください。

行の長さが長すぎると可読性が下がってしまい、メンテナンス性が下がります。 1 行の長さを 80 文字までにすることを目指しましょう。しかしながら、場合によっては少々長くなってしまってもかまいませんが PHP コードの行の長さは、最大 120 文字までにするようにしましょう。

PHPファイルの文字コードはUTF-8です。 UTF-8の文字コードは、AJAX処理などで他の文字コードより文字化けする可能性が少ないので、UTF-8を採用しています。

PHPファイル以外のDBやHTMLなどの文字コードもUTF-8で統一しています。

行末の扱いは、標準的な Unix テキストファイルの方式にあわせます。行末は、ラインフィード(LF) のみにしなければなりません。この文字のコードは 10、あるいは 16 進形式で 0x0A となります。

注意 : Apple OS (MAC等)の標準の設定はキャリッジリターン (CR) (0x0D)です。また Windows OS の標準の設定はキャリッジリターンとラインフィードの組み合わせ (CRLF) (0x0D, 0x0A) ですので、注意してください。