全般
必須 プロトコル
絶対パスでのリソース読み込みは可能な限りHTTPS(https:
)を使用する。
詳細
画像やその他のメディアファイル、スタイルシート、スクリプトには、HTTPS経由で利用できない場合を除き、常にHTTPS(https:
)を使用します。
BAD
<!-- プロトコル省略は非推奨 -->
<script src="//code.jquery.com/jquery-3.6.3.min.js"></script>
<!-- HTTPの使用は非推奨 -->
<script src="http://code.jquery.com/jquery-3.6.3.min.js"></script>
GOOD
<script src="https://code.jquery.com/jquery-3.6.3.min.js"></script>
必須 インデント
インデントは半角スペース(U+0020)2つを1単位とする。
詳細
タブ(U+0009)でインデントしたり、タブと半角スペースを混在させることはできません。
GOOD
<ul>
<li>Fantastic</li>
<li>Great</li>
</ul>
GOOD
.example {
color: blue;
}
必須 行末尾の空白
行末尾の空白は削除する。
詳細
行末尾の空白は不要であり、差分がわかりにくくなるため削除します。
BAD
<p>行末尾に半角スペースあり</p>
GOOD
<p>行末尾に半角スペースなし</p>
必須 ファイル末尾の改行
ファイル末尾は改行する。
詳細
差分がわかりにくくなるためファイル末尾の行では改行します。
BAD
...
</html>
GOOD
...
</html>
必須 エンコーディング
UTF-8(BOMなし)を使用する。
詳細
エディターの文字エンコードがUTF-8(BOMなし)に設定されていることを確認します。
HTMLの場合は<meta charset="utf-8">
でHTML文書のエンコーディングを指定します。
スタイルシートはUTF-8を想定しているためエンコーディングを指定しません。
(エンコーディングの詳細とその指定方法は、W3CのHandling character encodings in HTML and CSSを参照してください。)
必須 改行コード
LFを使用する。
詳細
エディターの改行コードがLFに設定されていることを確認します。
note
Windowsの場合はGit操作時に改行コードが自動変換されないよう.gitconfigのcore.autocrlf
の設定も確認します。
推奨 コメント
必要に応じてコメントでコードを説明する。
詳細
基本方針としては、コメントを記述しなくても読み手が理解できるコードを書くように心がけます。
コメントを記述する必要がある場合は、そのコードが何を意図しているか、どんな目的を果たしているか、なぜその解決アプローチが使用されているかを記述します。
必須 ライセンス遵守
ライブラリやフレームワーク(CSSリセットなども含む)を利用する際はライセンスを遵守する。
詳細
ライセンスが商用利用可能であることを確認します。
商用利用が可能なライセンス
必須 ライセンス表記
ライブラリやフレームワーク(CSSリセットなども含む)を利用する際、ライセンス表記のコメントは削除しない。
詳細
コードをコンパイル/圧縮した際にライセンス表記のコメントが削除されていないか必ず確認します。