LoginSignup
22
25

More than 5 years have passed since last update.

コーディング規約

Last updated at Posted at 2014-09-13

概要

開発する上でコーディング規約に則って開発を行う。
規約を決めるとソースコードに統一性を持たせ、可読性・保守性を高める。

  • PHPファイルの書式
  • コーディングスタイル

PHPファイルの書式

◆全般

「PHPコードのみのファイル」は終了タグ("?>")を含めてはいけない。終了タグを省略することで、ファイルの最後にある空白文字が出力に影響することを防ぐ。

<?php
echo "Hello";
◆字下げ

字下げは空白4文字で行う。タブ文字を利用してはいけない。

◆1行の長さ

1行の長さは80文字までにすることを目指す。最大でも120文字までにする。

◆行末

行末はラインフィード(LF)のみにしなければならない。

コーディングスタイル

◆変数名

変数名は英数字からなる単語をアンダースコアで区切ったスタイルで記述する。

$string, $base_url
◆関数名

関数名は英数字からなる単語をアンダースコアで区切ったスタイルで記述する。英字は全て小文字にする。

delete_null_byte(), is_admin()
◆クラス名

クラス名は単語の1文字目を大文字、それ以外を小文字にして連結したスタイル(アッパーキャメルケース)で記述する。

AccountController, ClassLoader
◆メソッド名

メソッド名は先頭以外の単語の1文字目を大文字、それ以外を小文字にして連結したスタイル(ローワーキャメルケース)で記述する。

runAction(), getRequest()
◆関数/クラス/メソッド定義の波括弧

関数/クラス/メソッド定義の波括弧は、それぞれ独立した行に記述する。

◆文字列
// 文字列リテラル
$a = "文字列";
// 変数の展開
$greeting = "こんにちは $name さん。";
// 文字列の連結
$str = "abc"."def";
◆配列
// 数値添字の配列
$sampleArray = array(1, 2, 3, "abc", "def");
// 連想配列
$sampleArray = array(
    "firstKey" => "firstValue",
    "secondKey" => "secondValue",
);
◆クラス
  • 開始波括弧は常にクラス名の下に書かなければならない。
  • PHPDocumentorの標準形式のドキュメントブロックが必要。
  • クラス内のコードは、全て空白4文字で字下げする。
/**
 * ドキュメントブロック
 */
class SampleClass
{
    // 空白4文字の字下げを使用
}
◆関数およびメソッド
  • メソッド宣言に private, protected, public のいずれかの修飾子を用いてアクセス範囲を指定する。
  • 波括弧は関数名の次の行に書く。関数名と引数定義用の開始括弧の間にスペースを入れてはいけない。
/**
 * ドキュメントブロック
 */
class Foo
{
    /**
     * ドキュメントブロック
     */
    public function bar()
    {
        // 空白4文字の字下げを使用
    }
}
◆制御構造
  • if および elseif 系の制御構造は、条件を指定するカッコの前に空白を一つ入れる。
  • 条件指定の括弧を閉じた後も空白をひとつ入れる。
if ($a != 2) {
    $a = 2;
} elseif ($a == 3) {
    $a = 4;
} else {
    $a = 7;
}

<参照>
http://framework.zend.com/manual/1.12/ja/coding-standard.html

22
25
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
22
25