現状、クラス等は実装していないため、本規約では定義しておらず、実装機会があり次第定義する。
HTML
class・id
class・idともに、小文字で書き、単語をハイフン「-」で結合したものを使用する。ただし、はてなブログの目次を導入した際の見出しタグのidは例外とする。
classはCSS、idはページ内ジャンプやJavaScriptで利用することを目標として使用する。
CSS
WordPressのコーディング規約をベースに、個人的に使いやすいように設定。
構造
インデントは4スペースとする。
セクション間には空白行を1行挿入する。
プロパティ
色は16進コードとし、大文字を避ける。可能であっても値を縮めない。
可能な限りショートハンドを使用する。指定が1つのみの場合はこの限りではない。
順序
JavaScript
WordPressのコーディング規約をベースに、個人的に使いやすいように設定。
jQueryなどのプラグインの使用は極力控える。
命名規則
変数名・関数名は、省略しない完全な単語を使用し、最初の文字を小文字にしたcamelCaseを使用する。
例外的にイテレータは、例えばi
などを使用する。
インデントと改行
インデントは4スペースとする。
スペース
以下の箇所にはスペースを入れる。
- 演算子の前後
- 条件式と開始ブレースの間
- for文の「;」と条件式の間
以下の箇所にはスペースを入れない。
- 行末や空行
- 単項特殊文字演算子(例:「++」「--」)の直前
- 「,」「;」の直前
- オブジェクト定義内のプロパティ名と続く「:」の間
- 空のコンストラクタ(例:「{}」「[]」「fn()」)
変数宣言
「let」「const」を使用し、「var」の使用は控える。
ブロックとブレース
if、else、for、while、tryブロックは常にブレース{}
を使用し、常に複数行にする。
開始ブレースは関数定義、条件、ループと同じ行に記述する。
ブロック内部はインデントを入れる。
終了ブレースはブロックの最終行から改行して記述する。
文字列
文字列にはシングルクォートを使用する。
文字列内にシングルクォートが含まれる場合は、\
でエスケープする。
比較演算子
==
ではなく、===
を使用する。
コメント
コメントは参照するコードの前行に記述する。
コメントトークンは//
とし、トークンとコメントの間には1スペース空ける。
過度な長さの文
オブジェクト・配列
基本1行で定義する。ただし、過度な長さとなる場合は、インデントを加えて1行ごとに1つのメンバーを定義し、行末は「,」終わりとする。
計算式・条件式・論理式
基本1行で定義する。ただし、過度な長さとなる場合は、演算子の直後でインデントを入れて改行する。
連続したメソッド呼び出し
連続してメソッドを呼び出し、文が長く、折り返す場合は、最初の呼び出し位置に合わせて、1行に1呼び出しを記述する。