auxak コーディング規約

auxakでは、開発効率の向上と保守性の高い可読性の良いプログラムを開発するため、以下に定める各プログラミング言語のコーディング規約に基づきコーディングを行うものとする。

≪ＰＨＰ≫

www.php-fig.orgが定めたPHPのコーディング規約である「Proposing a Standards Recommendation（PSR）」に準拠ものとする。

• PSR-0,  Autoloading Standard
• PSR-1, Basic Coding Standard
• PSR-2, Coding Style Guide
• PSR-3, Logger Interface
• PSR-4, Improved Autoloading

株式会社インフィニットループの技術ブログにて日本語訳が公開中。

[補足]

変数の命名規約

PSRでは、変数の命名規約に関して指定の記法は推奨しておらず、合理的な範囲内で一貫性の記述であれば”$StudｌyCaps”、”$camelCase”、”$under_score”のどの記法でも良いとされています。そのため、auxakでは”$under_score”を変数名の命名規約に採用するものとする。

（参考：PSR-1, 4. Class Constants, Properties, and Methods, 4.2 Properties）

$age;
$first_name;

単一行コメント

「//」を用いで記述する。「//」とコメントの先頭文字との間にはスペースを1文字挿入すること。

// single-line comment

ブロックコメント

複数行に渡るコメントはコメントブロック（「/*　<コメント>　*/」）を用いる。

「/*」及び「*/」はそれ単体で1行として記述し、その間に記述した「*（アスタリスク）」で始める行に記述する。

「*」とコメントの先頭文字との間にはスペースを1文字挿入すること。

「*」の位置を統一すること。

/*
 *  block comment
 */

≪データベース≫

テーブル名称

・複数形の英単語で命名する。但し、不加算名詞は例外とする。

・アルファベットは、全て小文字で表記する。

・複数の英単語で構成される名称は、スネークケースで表記する。

フィールド名称

・単数形の英単語で命名する。

・アルファベットは、全て小文字する。

・複数の英単語で構成される名称は、スネークケースで命名する。

・主キーは、「id」とする。

・外部キーは、「<参照元のjoinテーブル名称の単数形の英単語>_id」とする。

・DATE型の場合、

末尾に「_at」を付加する。過去の日時を表現する場合は、過去形で「xxxed_at」のように命名する。

・BOOLEAN型の場合、下表のような、「~able」や受動態、形容詞を使った名称とする。

≪HTML≫

後報

≪CSS≫

後報

≪JavaScript≫

後報