メンテナブルJavaScript 第I部スタイルガイドライン より
1.1 インテント:半角スペース4つ
各エディタや環境で異なる結果を引き起こさない為に
各規約を参照した結果、間を取って4つ
いずれにせよ、自分の慣れたパターンでない場合はとても読みにくいですよね...
1.2 文の終端:ASI(自動セミコロン挿入)機能があるので、改行には気をつけること
書き方によっては、動かなくなる原因になるそうです。
1.3.4 1行の長さ:80文字
長い場合は、演算子(カンマや&&など)の後で改行し、2レベル下げる
ただし、変数に代入する場合は、イコールの位置に合わせる
1.6 命名規約:キャメルケース
- 名詞で始める、関数の場合は動詞で始める
- データ型を示唆する名前、短め、無意味な名前は避ける
(ex. count,name,setName,...) - 定数:すべて大文字、単語の間はアンダースコア
※ただし簡単に上書きできてしまうので気をつけること
コンストラクタはPascalケースで定義する
(ex. Person)
1.7 リテラル値
- 文字列:長文の場合は、途中で区切って、連結する
- 数値:8進数は禁止
- undefined:typeofを使うときは注意,基本はnullを代入しておこう
- オブジェクトリテラル
// Good var book = { title: "Maintainable JavaScript", author: "Nicholas C. Zakas" };
- 配列リテラル
// Good var colors = [ "red", "green", "blue" ]; var numbers = [ 1, 2, 3, 4 ];
2.0 コメント
- 意味のある文章を
-> 意識しないと変な文章を付けがちなので、反省・・・ - エラーになりそうな箇所にコメントする
※ 特に意味があって一般的でないやり方をしていて、容易に修正されたら困る場合など - ドキュメントコメント
YUIライブラリ, JSDoc Toolkitを使ってJSDocを作る予定のときは特に注意しよう!
関連エントリ
- メンテナブルJavaScriptまとめ この本に紹介されているツールを全てまとめました。
この本
メンテナブルJavaScript ―読みやすく保守しやすいJavaScriptコードのための作法
- 作者: Nicholas C. Zakas,豊福剛
- 出版社/メーカー: オライリージャパン
- 発売日: 2013/03/06
- メディア: 大型本
- 購入: 7人 クリック: 31回
- この商品を含むブログ (7件) を見る