PHP スタイルガイド¶

somelibrary.php
someLibrary.php
SOMELIBRARY.php
Some_Library.php

Application_config.php
Application_Config.php
applicationConfig.php

Somelibrary.php
Some_library.php

applicationconfig.php
application_config.php

class superclass
class SuperClass

class Super_class

class Super_class {

        public function __construct()
        {

        }
}

function fileproperties()               // 言い表せておらず、アンダースコアで区切ることが求められます
function fileProperties()               // 言い表せておらず、 キャメルケースを使用しています
function getfileproperties()            // 良くなりました！　でもまだアンダースコア区切りが抜けています
function getFileProperties()            // キャメルケースを使っています
function get_the_file_properties_from_the_file()        // くどいです

function get_file_properties()  // よく言い表せており、アンダースコア区切りで、すべて小文字です

$j = 'foo';             // 1 文字変数は for() ループの中でだけ使用されるべきです
$Str                    // 大文字を含んでいます
$bufferedText           // キャメルケースを使っています。また、意味の欠落なく短くできます。
$groupid                // 複数単語です、アンダースコア区切りが求められます
$name_of_last_city_used // 長いです

for ($j = 0; $j < 10; $j++)
$str
$buffer
$group_id
$last_city

/**
 * スーパークラス
 *
 * @package     パッケージ名
 * @subpackage  サブパッケージ
 * @category    カテゴリ
 * @author      作者
 * @link        http://example.com
 */
class Super_class {

/**
 * XML 向けに文字列をエンコードする
 *
 * @param       string  $str    入力文字列
 * @return      string
 */
function xml_encode($str)

/**
 * クラス操作のデータ
 *
 * @var array
 */
public $data = array();

// 改行ごとに分割する
$parts = explode("\n", $str);

// 何が起きるか、なぜなのかについてとても詳細に説明する必要のある
// 長いコメントは複数の一行コメントを使用できます。
// 幅は意味のあるものとし、一番読みやすい 70 文字前後になるよう
// 努めてください。永続的な外部リソースへリンクするのを躊躇しないでください。
// それはより優れた説明をしてくれるでしょう。
//
// http://example.com/information_about_something/in_particular/

$parts = $this->foo($parts);

myConstant      // アンダースコア区切りがなく、すべてを大文字にはしていません
N               // 1 文字定数はだめです
S_C_VER         // 意味が伝わりません
$str = str_replace('{foo}', 'bar', $str);       // LD 定数と RD 定数を使うべきです

MY_CONSTANT
NEWLINE
SUPER_CLASS_VERSION
$str = str_replace(LD.'foo'.RD, 'bar', $str);

if ($foo == true)
$bar = false;
function foo($bar = null)

if ($foo == TRUE)
$bar = FALSE;
function foo($bar = NULL)

if ($foo || $bar)
if ($foo AND $bar)  // 問題ありませんが推奨されません、一般的なシンタックスハイライトアプリのためです
if (!$foo)
if (! is_array($foo))

if ($foo OR $bar)
if ($foo && $bar) // 推奨です
if ( ! $foo)
if ( ! is_array($foo))

// もし 'foo' が文字列の先頭にあれば、 strpos は 0 を返します。
// この条件式の評価結果は TRUE となります。
if (strpos($str, 'foo') == FALSE)

if (strpos($str, 'foo') === FALSE)

function build_string($str = "")
{
        if ($str == "") // おおっと！　引数に FALSE や 整数値 0 が渡されたらどうなりますか？
        {

        }
}

function build_string($str = "")
{
        if ($str === "")
        {

        }
}

$str = (string) $str; // $str を文字列としてキャストします

function foo($bar) {
        // ...
}

foreach ($arr as $key => $val) {
        // ...
}

if ($foo == $bar) {
        // ...
} else {
        // ...
}

for ($i = 0; $i < 10; $i++)
        {
        for ($j = 0; $j < 10; $j++)
                {
                // ...
                }
        }

try {
        // ...
}
catch() {
        // ...
}

function foo($bar)
{
        // ...
}

foreach ($arr as $key => $val)
{
        // ...
}

if ($foo == $bar)
{
        // ...
}
else
{
        // ...
}

for ($i = 0; $i < 10; $i++)
{
        for ($j = 0; $j < 10; $j++)
        {
                // ...
        }
}

try
{
        // ...
}
catch()
{
        // ...
}

$arr[ $foo ] = 'foo';

$arr[$foo] = 'foo'; // 配列のキーの周囲にはスペースを入れません

function foo ( $bar )
{

}

function foo($bar) // 関数宣言の丸括弧の周囲にはスペースを入れません
{

}

foreach( $query->result() as $row )

foreach ($query->result() as $row) // PHP 制御構造のうしろにはスペース 1 つを入れます、しかし丸括弧の内側には入れません

return "Invalid Selection";

return $this->lang->line('invalid_selection');

public function convert_text()
private function _convert_text()

if (ini_get('display_errors') == 1)
{
        exit "Enabled";
}

ini_set('display_errors', 1);

<? echo $foo; ?>

<?=$foo?>

<?php echo $foo; ?>

$foo = 'this'; $bar = 'that'; $bat = str_replace($foo, $bar, $bag);

$foo = 'this';
$bar = 'that';
$bat = str_replace($foo, $bar, $bag);

"My String"                                     // 変数展開はありませんので、ダブルクォートは使わないでください
"My string $foo"                                // 波括弧が必要です
'SELECT foo FROM bar WHERE baz = \'bag\''       // 読みにくいです

'My String'
"My string {$foo}"
"SELECT foo FROM bar WHERE baz = 'bag'"

// キーワードが小文字になっており、 1 行に納めるにはクエリが長すぎます
// (... は行が続くことを表しています)
$query = $this->db->query("select foo, bar, baz, foofoo, foobar as raboof, foobaz from exp_pre_email_addresses
...where foo != 'oof' and baz != 'zab' order by foobaz limit 5, 100");

$query = $this->db->query("SELECT foo, bar, baz, foofoo, foobar AS raboof, foobaz
                                FROM exp_pre_email_addresses
                                WHERE foo != 'oof'
                                AND baz != 'zab'
                                ORDER BY foobaz
                                LIMIT 5, 100");

function foo($bar = '', $baz = FALSE)