peeks-blog

自分用メモ

随時追記していく

JavaScript style guide（MDN）の主な規約

※あくまで規約であって、構文規則でない点に注意。

①基本
・１行あたりの桁数は8０文字以下
・ファイルの末尾は改行する
・カンマ、セミコロンの後方にはスペースを入れる
・関数やオブジェクトなどの定義ブロックの前後は空行で区切る

②空白
・インデントはスペース２個で表現する（タブは使わない）→そうなんだ
・２項演算子は空白で区切る
・カンマ、セミコロン、キーワードの後方には空白を含める
（ただし、行末の空白は不要）

③命名規則
・変数、関数名は先頭小文字のキャメルケース形式→ロワーキャメルケース
・定数名はすべて大文字のアンダースコア形式
・コンストラクタ、クラス名は先頭大文字のキャメルケース形式→アッパーキャメルケース
・プライベートメンバーは「_」で始める
・イベントハンドラー関数は「on」で始める

④その他
・すべての変数は宣言、初期化する
・変数の宣言が重複しない
・配列、オブジェクトの生成には[]、{}などのリテラル構文を使用する
・真偽値をtrue, falseと比較しない

Google標準のコーディングスタイル

・jsファイルの名前は小文字で統一
・セミコロンは省略しない
・文字列のくくりには「”」よりも「’」を優先して使用する
・基本データ型（string, number, boolean）のラッパーオブジェクトは使用しない
・名前空間を利用して、グローバルレベルの名前は最小限に抑える
・ブロックを表す{}の前に改行は入れない
・ビルドインオブジェクトのプロトタイプは書き換えない
・with / eval命令は使用しない
・for…in命令は連想配列、ハッシュでのみ利用する

※ここで示されてるガイドラインは、コードを読みやすくするというだけでなく、
　「安全な」コードを記述するという意味でも重要である。

PSR（PHP Standarts Rrcommendations）

・PHPタグは「 ・文字コードはUTF-8（BOMなし）、改行コードはLFを利用する
・ファイル末尾の終了タグ「?>」は省略する
・インデントは空白４文字（タブ文字は不可）
・１行あたりの桁数は８０桁（最大でも１２０桁）
・クラス。関数などを定義したコードと、なんらかの副作用を伴うコードはファイルを分離する
・クラス名はパスカル形式（アッパーキャメルケース）、
　メソッド名はキャメルケース形式（ロワーキャメルケース）であること
・プロパティ名はアッパーキャメルケース、ロワーキャメルケース、
　アンダースコア（スネーク）形式いずれでもかまわないが、一貫してること
・クラス定数はすべて大文字とし、区切り文字にアンダースコアを利用する
・すべてのプロパティ、メソッドにアクセス修飾子を明記すること
・abstract, final修飾子はアクセス修飾子よりも前に記述すること