コンテンツにスキップ
開発ガイドライン
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

HTML のコードスタイル

テンプレートごとのフォーマッター・リンターと、HTML のインデント・コメントのルール

フォーマッターとリンター

HTML のフォーマットと検査は、開発環境テンプレートに用意された設定で自動化します。手動でフォーマットを整える必要はありません。

テンプレート 使用するツール
静的サイト(Vite) Biome(フォーマット・リント)、markuplint(HTML の検査)
静的サイト(Astro) Prettier(フォーマット。.astro は prettier-plugin-astro で整形)、ESLint(eslint-plugin-jsx-a11y によるアクセシビリティの検査)
WordPress(wp-env) Prettier(フォーマット。PHP テンプレートは @prettier/plugin-php で整形)

案件ごとにインデントなどの規則が指定されている場合は、そちらに従ってください。

インデントと改行

インデントは半角 2 スペースとし、タブと混在させません。1 行の長さや属性の改行位置は、フォーマッターの出力に従います。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>ページタイトル</title>
  </head>
  <body>
    <header>
      <a href="/">サイト名</a>
    </header>
    <main>
      <h1>ページタイトル</h1>
      <section>
        <h2>セクションタイトル</h2>
        <p>段落テキスト</p>
      </section>
    </main>
  </body>
</html>

viewport(meta)

<head> に次を置きます。表示幅の考え方は アクセシビリティ の「表示幅の基準」にまとめています。

<meta name="viewport" content="width=device-width, initial-scale=1" />
  • user-scalable=no や maximum-scale=1 は付けません。ピンチで画面を拡大できなくなるためです。
  • 375px より狭い端末向け(任意): 狭い実機でもレイアウトの崩れや横スクロールを抑えたいときに使う方法です。CSS を組み直すのではなく、画面の幅が 375px 以下になったら <meta name="viewport"> の content を次に切り替え、375px 用の見た目をそのまま縮小表示します。向きの変更やウィンドウのリサイズにも合わせて切り替えるため、JavaScript で幅を監視して更新します。処理はプロジェクト共通の関数(例: initializeViewport)にまとめることが多く、短い間隔で何度も書き換えないよう、少し待ってから反映する(debounce)こともあります。
<meta name="viewport" content="width=375" />
  • WCAG の Reflow(320px)が契約で必須の場合: 上記の縮小表示は使いません。viewport の幅を固定せず、CSS で 320px まで横スクロールなしで読めるようにします(アクセシビリティ の「拡大と表示幅」)。

コメント

開発用のメモは、出力されない形式(PHP のコメントや、テンプレートエンジンのコメント)で書いてください。

このページは役に立ちましたか?