Translations: English · বাংলা · Dansk · Deutsch · Español · فارسی · Français · Indonesia · 日本語 · 한국어 · Português (BR) · Română · Русский · Türkçe · Українська · Tiếng Việt · 简体中文 · 正體中文

普通のHTMLの書き方

保守しやすく、規模に依存しないHTML文書のために

一般

DOCTYPEで始める

DOCTYPEは標準モードを有効にするために必要です。

悪い例:

<html>
  ...
</html>

良い例:

<!DOCTYPE html>
<html>
  ...
</html>

置き換えられるべきまたは旧式のDOCTYPEを使わない

もはやDOCTYPEはDTDのためにあるわけではないので、シンプルにしましょう。

悪い例:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  "http://www.w3.org/TR/html4/strict.dtd">

良い例:

<!DOCTYPE html>

XML宣言を使用しない

まだXHTMLを書きたいんですか？

悪い例:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE html>

良い例:

<!DOCTYPE html>

文字参照はできる限り使わない

UTF-8でHTML文書を書くなら、Emojiも含めほとんどあらゆる文字はそのまま書けます。

悪い例:

<p><small>Copyright &copy; 2014 W3C<sup>&reg;</sup></small></p>

良い例:

<p><small>Copyright © 2014 W3C<sup>®</sup></small></p>

`&`と`<`、`>`、`"`、`'`は名前文字参照を使ってエスケープする

バグのないHTML文書を作成するためには、これらの文字は常にエスケープされるべきです。

悪い例:

<h1>The "&" character</h1>

良い例:

<h1>The &quot;&amp;&quot; character</h1>

制御文字や不可視文字は数値文字参照を使う

これらの文字は簡単に他の文字と間違えられてしまいます。また仕様では、これらの文字へ人間にわかりやすい名前を付けていることを保証していません。

悪い例:

<p>This book can read in 1 hour.</p>

良い例:

<p>This book can read in 1&#xA0;hour.</p>

コメントではその内容の前後へ空白文字を置く

いくつかの文字はコメントの開始直後や終了直前に書けません。

悪い例:

<!--This section is non-normative-->

良い例:

<!-- This section is non-normative -->

終了タグを省略しない

多分、あなたは終了タグを省略するためのルールを理解していないでしょう。

悪い例:

<html>
  <body>
    ...

良い例:

<html>
  <body>
    ...
  </body>
</html>

空要素の書き方を混ぜない

一貫性は読みやすさのキーポイントです。

悪い例:

<img alt="HTML Best Practices" src="/img/logo.png">
<hr />

良い例:

<img alt="HTML Best Practices" src="/img/logo.png">
<hr>

タグや属性値の前後へ空白文字を置かない

そうする必要はまったくありません。

悪い例:

<h1 class=" title " >HTML Best Practices</h1>

良い例:

<h1 class="title">HTML Best Practices</h1>

大文字・小文字を混ぜない

これも一貫性を与えてくれます。

悪い例:

<a HREF="#general">General</A>

良い例:

<a href="#general">General</a>

同じく良い例:

<A HREF="#general">General</A>

引用符を混ぜない

上に同じです。

悪い例:

<img alt="HTML Best Practices" src='/img/logo.jpg'>

良い例:

<img alt="HTML Best Practices" src="/img/logo.jpg">

属性を2文字以上の空白文字で区切らない

あなたのよくわからない整形ルールは誰かを混乱させます。

悪い例:

<input   name="q"  type="search">

良い例:

<input name="q" type="search">

真偽値を取る属性の値は省略する

この方が簡単に書けますよね？

悪い例:

<audio autoplay="autoplay" src="/audio/theme.mp3">

良い例:

<audio autoplay src="/audio/theme.mp3">

名前空間は省略する

SVGやMathMLはHTMLの文書では直接扱えます。

悪い例:

<svg xmlns="http://www.w3.org/2000/svg">
  ...
</svg>

良い例:

<svg>
  ...
</svg>

XML属性は使わない

我々はHTML文書を書いています。

悪い例:

<span lang="ja" xml:lang="ja">...</span>

良い例:

<span lang="ja">...</span>

`data-*`とMicrodata、RDFa Lite用の属性と通常の属性を混ぜない

タグ文字列はとても複雑になりえます。こういった簡単なルールによってタグ文字列を読みやすくできるでしょう。

悪い例:

<img alt="HTML Best Practices" data-height="31" data-width="88" itemprop="image" src="/img/logo.png">

良い例:

<img alt="HTML Best Practices" src="/img/logo.png" data-width="88" data-height="31" itemprop="image">

デフォルトの暗黙のARIAセマンティックスを尊重する

いくつかの要素はHTML文章において暗黙的にARIA roleを持っているので、それは指定しないようにしましょう。

悪い例:

<nav role="navigation">
  ...
</nav>

<hr role="separator">

良い例:

<nav>
  ...
</nav>

<hr>

文書要素

`lang`属性を追加する

lang属性はHTML文書の翻訳に役立ちます。

悪い例:

<html>

良い例:

<html lang="en-US">

`lang`属性の値はできる限り短くする

日本語は日本でのみ使われます。つまり国コードは必要ありません。

悪い例:

<html lang="ja-JP">

良い例:

<html lang="ja">

できる限り`data-*`属性は避ける

適切な属性は、ブラウザーがうまく扱ってくれるかもしれません。

悪い例:

<span data-language="french">chemises</span>
...
<strong data-type="warning">Do not wash!</strong>

良い例:

<span title="French"><span lang="fr">chemises</span></span>
...
<strong class="warning">Do not wash!</strong>

文書メタデータ

`title`要素を書く

title要素の中身は、ブラウザーに限らず、様々なアプリケーションにより利用されます。

悪い例:

<head>
  <meta charset="UTF-8">
</head>

良い例:

<head>
  <meta charset="UTF-8">
  <title>HTML Best Practices</title>
</head>

`base`要素を使わない

絶対パスや絶対URLの方が開発者とユーザーの双方に安全です。

悪い例:

<head>
  ...
  <base href="/blog/">
  <link href="hello-world" rel="canonical">
  ...
</head>

良い例:

<head>
  ...
  <link href="/blog/hello-world" rel="canonical">
  ...
</head>

マイナーな参照先リソースのMIMEタイプを指定する

アプリケーションがそのリソースをどう取り扱うべきかのヒントになります。

悪い例:

<link href="/pdf" rel="alternate">
<link href="/feed" rel="alternate">
<link href="/css/screen.css" rel="stylesheet">

良い例:

<link href="/pdf" rel="alternate" type="application/pdf">
<link href="/feed" rel="alternate" type="application/rss+xml">
<link href="/css/screen.css" rel="stylesheet">

`favicon.ico`へリンクしない

ほとんどのブラウザーは/favicon.icoを自動的に非同期で取得します。

悪い例:

<link href="/favicon.ico" rel="icon" type="image/vnd.microsoft.icon">

良い例:

<!-- Place `favicon.ico` in the root directory. -->

`apple-touch-icon`へのリンクを書く

デフォルトでリクエストされるタッチ・アイコンのパスは突然変わりました。

Bad:

<!-- Hey Apple! Please download `/apple-touch-icon.png`! -->

Good:

<link href="/apple-touch-icon.png" rel="apple-touch-icon">

代替スタイルシートへ`title`属性を追加する

人間にわかりやすいラベルにより適切なスタイルシートを選択しやすくなります。

悪い例:

<link href="/css/screen.css" rel="stylesheet">
<link href="/css/high-contrast.css" rel="alternate stylesheet">

良い例:

<link href="/css/screen.css" rel="stylesheet">
<link href="/css/high-contrast.css" rel="alternate stylesheet" title="High contrast">

URLには`link`要素を使う

href属性の値はURLとして解決できます。

悪い例:

<section itemscope itemtype="http://schema.org/BlogPosting">
  <meta content="https://example.com/blog/hello" itemprop="url">
  ...
</section>

良い例:

<section itemscope itemtype="http://schema.org/BlogPosting">
  <link href="/blog/hello" itemprop="url">
  ...
</section>

文書の文字エンコーディングを指定する

まだすべてのブラウザーでUTF-8がデフォルトになっていません。

悪い例:

<head>
  <title>HTML Best Practices</title>
</head>

良い例:

<head>
  <meta charset="UTF-8">
  <title>HTML Best Practices</title>
</head>

置き換えられるべき文字エンコーディング指定フォーマットを使わない

HTTPヘッダーはサーバー側で指定されるべきで、簡単にしておきましょう。

悪い例:

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

良い例:

<meta charset="UTF-8">

最初に文字エンコーディングを指定する

仕様では文書の先頭1024バイトまでに文字エンコーディングを指定することを要求しています。

悪い例:

<head>
  <meta content="width=device-width" name="viewport">
  <meta charset="UTF-8">
  ...
</head>

良い例:

<head>
  <meta charset="UTF-8">
  <meta content="width=device-width" name="viewport">
  ...
</head>

UTF-8を使う

UTF-8ならEmojiを自由に使えます。

悪い例:

<meta charset="Shift_JIS">

良い例:

<meta charset="UTF-8">

CSSの`type`属性は省略する

HTMLでは、style要素におけるtype属性の初期値はtext/cssです。

悪い例:

<style type="text/css">
  ...
</style>

良い例:

<style>
  ...
</style>

`style`要素の中をコメントアウトしない

この儀式は古いブラウザーのためです。

悪い例:

<style>
<!--
  ...
  -->
</style>

良い例:

<style>
  ...
</style>

CSSとJavaScriptのタグを混ぜない

script要素はDOMの構築をブロックするかもしれません。

悪い例:

<script src="/js/jquery.min.js"></script>
<link href="/css/screen.css" rel="stylesheet">
<script src="/js/main.js"></script>

良い例:

<link href="/css/screen.css" rel="stylesheet">
<script src="/js/jquery.min.js"></script>
<script src="/js/main.js"></script>

同じく良い例:

<script src="/js/jquery.min.js"></script>
<script src="/js/main.js"></script>
<link href="/css/screen.css" rel="stylesheet">

セクション

`body`要素を書く

ブラウザーは思っても見ない位置へbody要素を補完するかもしれません。

悪い例:

<html>
  <head>
    ...
  </head>
  ...
</html>

良い例:

<html>
  <head>
    ...
  </head>
  <body>
    ...
  </body>
</html>

`hgroup`要素のことは忘れる

あまり使われていません。

悪い例:

<hgroup>
  <h1>HTML Best Practices</h1>
  <h2>For writing maintainable and scalable HTML documents.</h2>
</hgroup>

良い例:

<h1>HTML Best Practices</h1>
<p>For writing maintainable and scalable HTML documents.</p>

`address`要素は連絡先情報にのみ使う

address要素はメールアドレスやSNSアカウント、住所、電話番号など、実際に利用できるあなたとの連絡手段のための要素です。

悪い例:

<address>No rights reserved.</address>

良い例:

<address>Contact: <a href="https://twitter.com/hail2u_">Kyo Nagashima</a></address>

グルーピングコンテンツ

`pre`要素は改行で始めない

最初の改行はブラウザーに無視されますが、2番目以降はそのまま表示されます。

悪い例:

<pre>
&lt;!DOCTYPE html&gt;
</pre>

良い例:

<pre>&lt;!DOCTYPE html&gt;
</pre>

`blockquote`要素内でも適切な要素を使う

blockquote要素の中身は引用で、単なる文字の連続ではありません。

悪い例:

<blockquote>For writing maintainable and scalable HTML documents.</blockquote>

良い例:

<blockquote>
  <p>For writing maintainable and scalable HTML documents.</p>
</blockquote>

`blockquote`要素内に帰属情報を含めない

blockquote要素の中身は引用です。

悪い例:

<blockquote>
  <p>For writing maintainable and scalable HTML documents.</p>

  <p>— HTML Best Practices</p>
</blockquote>

良い例:

<blockquote>
  <p>For writing maintainable and scalable HTML documents.</p>
</blockquote>

<p>— HTML Best Practices</p>

同じく良い例:

<figure>
  <blockquote>
    <p>For writing maintainable and scalable HTML documents.</p>
  </blockquote>

  <figcaption>— HTML Best Practices</figcaption>
</figure>

リスト項目は1行に1つずつ書く

長ーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーい行はとっっっっっっっっっっっっっっっっっっっっっっっっっっっても読みづらいです。

悪い例:

<ul>
  <li>General</li><li>The root Element</li><li>Sections</li>...
</ul>

良い例:

<ul>
  <li>General</li>
  <li>The root Element</li>
  <li>Sections</li>
  ...
</ul>

`ol`要素では`type`属性を使う

リスト・マーカーは周辺から参照される場合があります。type属性を使ってリスト・マーカーを変更すれば、安全に参照できるでしょう。

悪い例:

<head>
  <style>
    .toc {
      list-style-type: upper-roman;
    }
  </style>
</head>
<body>
  <ol class="toc">
    <li>General</li>
    <li>The root Element</li>
    <li>Sections</li>
    ...
  </ol>
</body>

良い例:

<body>
  <ol type="I">
    <li>General</li>
    <li>The root Element</li>
    <li>Sections</li>
    ...
  </ol>
</body>

`dl`を会話のために使わない

HTMLではdl要素は関連付けリストに限定されています。

悪い例:

<dl>
  <dt>Costello</dt>
  <dd>Look, you gotta first baseman?</dd>
  <dt>Abbott</dt>
  <dd>Certainly.</dd>
  <dt>Costello</dt>
  <dd>Who’s playing first?</dd>
  <dt>Abbott</dt>
  <dd>That’s right.</dd>
  <dt>Costello becomes exasperated.</dd>
  <dt>Costello</dt>
  <dd>When you pay off the first baseman every month, who gets the money?</dd>
  <dt>Abbott</dt>
  <dd>Every dollar of it.</dd>
</dl>

良い例:

<p>Costello: Look, you gotta first baseman?</p>
<p>Abbott: Certainly.</p>
<p>Costello: Who’s playing first?</p>
<p>Abbott: That’s right.</p>
<p>Costello becomes exasperated.</p>
<p>Costello: When you pay off the first baseman every month, who gets the money?</p>
<p>Abbott: Every dollar of it.</p>

`figcaption`要素は`figure`要素の最初か最後に置く

仕様ではfigcaption要素をfigure要素の中ほどに置けません。

悪い例:

<figure>
  <img alt="Front cover of the “HTML Best Practices” book" src="/img/front-cover.png">
  <figcaption>“HTML Best Practices” Cover Art</figcaption>
  <img alt="Back cover of the “HTML Best Practices” book" src="/img/back-cover.png">
</figure>

良い例:

<figure>
  <img alt="Front cover of the “HTML Best Practices” book" src="/img/front-cover.png">
  <img alt="Back cover of the “HTML Best Practices” book" src="/img/back-cover.png">
  <figcaption>“HTML Best Practices” Cover Art</figcaption>
</figure>

`main`要素を使う

main要素はコンテンツをまとめるために使えます。

悪い例:

<div id="content">
  ...
</div>

良い例:

<main>
  ...
</main>

できる限り`div`要素は避ける

div要素は最後の手段です。

悪い例:

<div class="chapter">
  ...
</div>

良い例:

<section>
  ...
</section>

テキストレベルセマンティックス

グループ化できるリンクは分割しない

a要素はほとんどの要素（フォームコントロールのようなインタラクティブ要素やa要素自身以外）を括れます。

悪い例:

<h1><a href="https://whatwg.org/">WHATWG</a></h1>

<p><a href="https://whatwg.org/">A community maintaining and evolving HTML since 2004.</a></p>

良い例:

<a href="https://whatwg.org/">
  <h1>WHATWG</h1>

  <p>A community maintaining and evolving HTML since 2004.</p>
</a>

リソースをダウンロードさせる場合は`download`属性を使う

こうすることでダウンロードするリンク先のリソースを確実にローカルに保存させられます。

悪い例:

<a href="/downloads/offline.zip">offline version</a>

良い例:

<a download href="/downloads/offline.zip">offline version</a>

`rel`や`hreflang`、`type`属性を必要ならば使う

これらのヒントは、アプリケーションがリンク先のリソースをどう扱えば良いのかの助けになります。

悪い例:

<a href="/ja/pdf">Japanese PDF version</a>

良い例:

<a href="/ja/pdf" hreflang="ja" rel="alternate" type="application/pdf">Japanese PDF version</a>

リンク文字列は明確にする

リンク文字列はリンク先のリソースのラベルであるべきです。

悪い例:

<p><a href="/pdf" rel="alternate" type="application/pdf">Click here</a> to view PDF version.</p>

良い例:

<p><a href="/pdf" rel="alternate" type="application/pdf">PDF version</a> is also available.</p>

`em`要素を警告や注意に使わない

それらは深刻なものです。ですからstrong要素の方がより相応しいはずです。

悪い例:

<em>Caution!</em>

良い例:

<strong>Caution!</strong>

できる限り`s`や`i`、`b`、`u`要素を避ける

これらの要素のセマンティックスは人類には難しすぎます。

悪い例:

<i class="icon-search"></i>

良い例:

<span class="icon-search" aria-hidden="true"></span>

`q`要素内へ引用符は置かない

引用符はブラウザーが提供します。

悪い例:

<q>“For writing maintainable and scalable HTML documents”</q>

良い例:

<q>For writing maintainable and scalable HTML documents</q>

同じく良い例:

“For writing maintainable and scalable HTML documents”

`abbr`要素へ`title`属性を追加する

他に完全表記を提示する方法がありません。

悪い例:

<abbr>HBP</abbr>

良い例:

<abbr title="HTML Best Practices">HBP</abbr>

`ruby`要素は冗長にマークアップする

ruby要素のサポートはまだモダンブラウザー間でも完了していません。

悪い例:

<ruby>HTML<rt>えいちてぃーえむえる</ruby>

良い例:

<ruby>HTML<rp> (</rp><rt>えいちてぃーえむえる</rt><rp>) </rp></ruby>

機械的に解釈可能でない`time`要素では`datetime`属性を追加する

datetime属性を使わない場合、time要素の中身は限定されます。

悪い例:

<time>Dec 19, 2014</time>

良い例:

<time datetime="2014-12-19">Dec 19, 2014</time>

コードの言語は`class`属性で`language-`で始めることで指定する

これは正式な方法ではありませんが、仕様では言及されています。

悪い例:

<code>&lt;!DOCTYPE html&gt;</code>

良い例:

<code class="language-html">&lt;!DOCTYPE html&gt;</code>

できる限り`kbd`要素はシンプルにする

入れ子にしたkbd要素は人類には難しすぎます。

悪い例:

<kbd><kbd>Ctrl</kbd>+<kbd>F5</kbd></kbd>

良い例:

<kbd>Ctrl+F5</kbd>

できる限り`span`要素は使わない

span要素は最後の手段です。

悪い例:

HTML <span class="best">Best</span> Practices

良い例:

HTML <em>Best</em> Practices

`br`要素の後ろでは改行する

br要素が使われる場所には、間違いなく改行が必要です。

悪い例:

<p>HTML<br>Best<br>Practices</p>

良い例:

<p>HTML<br>
Best<br>
Practices</p>

見た目だけのために`br`要素を使わない

br要素は改行のためにあるのではなく、コンテンツに必要な改行のためにあります。

悪い例:

<p><label>Rule name: <input name="rule-name" type="text"></label><br>
<label>Rule description:<br>
<textarea name="rule-description"></textarea></label></p>

良い例:

<p><label>Rule name: <input name="rule-name" type="text"></label></p>
<p><label>Rule description:<br>
<textarea name="rule-description"></textarea></label></p>

編集

`ins`や`del`要素は他の要素をまたがせない

要素は他の要素をまたげません。

悪い例:

<p>For writing maintainable and scalable HTML documents.<del> And for mental stability.</p>

<p>Don’t trust!</p></del>

良い例:

<p>For writing maintainable and scalable HTML documents.<del> And for mental stability.</del></p>

<del><p>Don’t trust!</p></del>

エンベディッドコンテンツ

`picture`要素ではフォールバックのための`img`要素を提供する

picture要素のサポートはまだよくありません。

悪い例:

<picture>
  <source srcset="/img/logo.webp" type="image/webp">
  <source srcset="/img/logo.hdp" type="image/vnd.ms-photo">
  <source srcset="/img/logo.jp2" type="image/jp2">
  <source srcset="/img/logo.jpg" type="image/jpg">
</picture>

良い例:

<picture>
  <source srcset="/img/logo.webp" type="image/webp">
  <source srcset="/img/logo.hdp" type="image/vnd.ms-photo">
  <source srcset="/img/logo.jp2" type="image/jp2">
  <img src="/img/logo.jpg">
</picture>

必要な時は`img`要素へ`alt`属性を追加する

alt属性は、画像を表示できなかったり、画像の読み込みを無効にしている環境へ助けになります。

悪い例:

<img src="/img/logo.png">

良い例:

<img alt="HTML Best Practices" src="/img/logo.png">

可能ならば`alt`属性は空にする

画像が補助的なものならば、きっと周囲に同等のコンテンツが存在するはずです。

悪い例:

<img alt="Question mark icon" src="/img/icon/help.png"> Help

良い例:

<img alt="" src="/img/icon/help.png"> Help

可能ならば`alt`属性は省略する

たまにどのような文字列が適切なalt属性の値かわからない場合もあります。

悪い例:

<img alt="CAPTCHA" src="captcha.cgi?id=82174">

良い例:

<img src="captcha.cgi?id=82174" title="CAPTCHA">
(If you cannot see the image, you can use an <a href="?audio">audio</a> test instead.)

`iframe`要素の中は空にする

その内容にはいくつかの制限があります。空にすれば安全です。

悪い例:

<iframe src="/ads/default.html">
  <p>If your browser support inline frame, ads are displayed here.</p>
</iframe>

良い例:

<iframe src="/ads/default.html"></iframe>

`map`要素の中はマークアップする

その中身はスクリーン・リーダーへ提供されます。

悪い例:

<map name="toc">
  <a href="#general">General</a>
  <area alt="General" coords="0, 0, 40, 40" href="#General"> |
  <a href="#the_root_element">The root element</a>
  <area alt="The root element" coords="50, 0, 90, 40" href="#the_root_element"> |
  <a href="#sections">Sections</a>
  <area alt="Sections" coords="100, 0, 140, 40" href="#sections">
</map>

良い例:

<map name="toc">
  <p>
    <a href="#general">General</a>
    <area alt="General" coords="0, 0, 40, 40" href="#General"> |
    <a href="#the_root_element">The root element</a>
    <area alt="The root element" coords="50, 0, 90, 40" href="#the_root_element"> |
    <a href="#sections">Sections</a>
    <area alt="Sections" coords="100, 0, 140, 40" href="#sections">
  </p>
</map>

`audio`や`video`要素にフォールバックのためのコンテンツを提供する

HTMLで新しく作られた要素にはフォールバックのためのコンテンツが必要です。

悪い例:

<video>
  <source src="/mov/theme.mp4" type="video/mp4">
  <source src="/mov/theme.ogv" type="video/ogg">
  ...
</video>

良い例:

<video>
  <source src="/mov/theme.mp4" type="video/mp4">
  <source src="/mov/theme.ogv" type="video/ogg">
  ...
  <iframe src="//www.youtube.com/embed/..." allowfullscreen></iframe>
</video>

テーブルデータ

1行に1つのセルを書く

長い行は把握しづらいです。

悪い例:

<tr>
  <td>General</td><td>The root Element</td><td>Sections</td>
</tr>

良い例:

<tr>
  <td>General</td>
  <td>The root Element</td>
  <td>Sections</td>
</tr>

見出しセルには`th`要素を使う

避ける理由はないでしょう。

悪い例:

<table>
  <thead>
    <tr>
      <td><strong>Element</strong></td>
      <td><strong>Empty</strong></td>
      <td><strong>Tag omission</strong></td>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><strong><code>pre</code></strong></td>
      <td>No</td>
      <td>Neither tag is omissible</td>
    </tr>
    <tr>
      <td><strong><code>img</code></strong></td>
      <td>Yes</td>
      <td>No end tag</td>
    </tr>
  </tbody>
</table>

良い例:

<table>
  <thead>
    <tr>
      <th>Element</th>
      <th>Empty</th>
      <th>Tag omission</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th><code>pre</code></th>
      <td>No</td>
      <td>Neither tag is omissible</td>
    </tr>
    <tr>
      <th><code>img</code></th>
      <td>Yes</td>
      <td>No end tag</td>
    </tr>
  </tbody>
</table>

フォーム

フォームコントロールは`label`要素で括る

label要素はフォーム要素へフォーカスを当てるのに役立ちます。

悪い例:

<p>Query: <input name="q" type="text"></p>

良い例:

<p><label>Query: <input name="q" type="text"></label></p>

可能ならば`for`属性は省略する

label要素はいくつかのフォーム要素を含められます。

悪い例:

<label for="q">Query: </label><input id="q" name="q" type="text">

良い例:

<label>Query: <input name="q" type="text"></label>

`input`要素では適切な`type`属性を使う

適切なtype属性により、ブラウザーはinput要素へちょっとした機能を与えてくれます。

悪い例:

<label>Search keyword: <input name="q" type="text"></label>

良い例:

<label>Search keyword: <input name="q" type="search"></label>

`input type="submit"`には`value`属性を追加する

送信ボタンは、そのデフォルトのラベルがブラウザーや言語設定によって変わってしまいます。

悪い例:

<input type="submit">

良い例:

<input type="submit" value="Search">

`pattern`属性を持つ`input`要素には`title`属性を追加する

もし入力したテキストがpattern属性にマッチしない場合、title属性の値がヒントとして表示されます。

悪い例:

<input name="security-code" pattern="[0-9]{3}" type="text">

良い例:

<input name="security-code" pattern="[0-9]{3}" title="A security code is a number in three figures." type="text">

`placeholder`属性をラベル付けに使わない

label要素がラベルのためにあり、placeholder属性は短いヒントのためにあります。

悪い例:

<input name="email" placeholder="Email" type="text">

良い例:

<label>Email: <input name="email" placeholder="john.doe@example.com" type="text"></label>

`option`要素は1行に1つ書く

長い行は把握しづらいです。

悪い例:

<datalist id="toc">
  <option label="General"><option label="The root element"><option label="Sections">
</datalist>

良い例:

<datalist id="toc">
  <option label="General">
  <option label="The root element">
  <option label="Sections">
</datalist>

`progress`要素には`max`属性を追加する

max属性があると、value属性を簡単な形式で書けます。

悪い例:

<progress value="0.5"> 50%</progress>

良い例:

<progress max="100" value="50"> 50%</progress>

`meter`要素では`min`及び`max`属性を追加する

minとmax属性があると、value属性を簡単な形式で書けます。

悪い例:

<meter value="0.5"> 512GB used (1024GB total)</meter>

良い例:

<meter min="0" max="1024" value="512"> 512GB used (1024GB total)</meter>

`legend`要素は`fieldset`要素の最初に置く

仕様がそう要求しています。

悪い例:

<fieldset>
  <p><label>Is this section useful?: <input name="usefulness-general" type="checkbox"></label></p>
  ...
  <legend>About "General"</legend>
</fieldset>

良い例:

<fieldset>
  <legend>About "General"</legend>
  <p><label>Is this section useful?: <input name="usefulness-general" type="checkbox"></label></p>
  ...
</fieldset>

スクリプティング

JavaScriptでは`type`属性を省略する

HTMLでは、script要素におけるtype属性の初期値はtext/javascriptです。

悪い例:

<script type="text/javascript">
  ...
</script>

良い例:

<script>
  ...
</script>

`script`要素の中をコメントアウトしない

この儀式は古いブラウザーのためです。

悪い例:

<script>
/*<![CDATA[*/
  ...
/*]]>*/
</script>

同じく悪い例:

<script>
<!--
  ...
// -->
</script>

良い例:

<script>
  ...
</script>

`script`要素を動的に生成するテクニックを使わない

明快さとパフォーマンスの両面でasync属性が最良です。

悪い例:

<script>
  var script = document.createElement("script");
  script.async = true;
  script.src = "//example.com/widget.js";
  document.getElementsByTagName("head")[0].appendChild(script);
</script>

良い例:

<script async defer src="https://example.com/widget.js"></script>

その他

一貫した量でインデントする

インデントは読みやすさにおいて重要です。

悪い例:

<html>
	<head>
	  ...
	</head>
  <body>
    ...
  </body>
</html>

良い例:

<html>
  <head>
    ...
  </head>
  <body>
    ...
  </body>
</html>

内部リンクには絶対パスを使う

絶対パスはインターネット回線のないローカルの環境でもうまく動きます。

悪い例:

<link rel="apple-touch-icon" href="http://you.example.com/apple-touch-icon-precomposed.png">
...
<p>You can find more at <a href="//you.example.com/contact.html">contact page</a>.</p>

良い例:

<link rel="apple-touch-icon" href="/apple-touch-icon-precomposed.png">
...
<p>You can find more at <a href="/contact.html">contact page</a>.</p>

外部リソースにはプロトコル相対URLを使わない

プロトコルを指定すると、外部リソースを確実かつ安全に読み込めます。

悪い例:

<script src="//example.com/js/library.js">

良い例:

<script src="https://example.com/js/library.js">

Contributors

@hail2u_
@momdo

Translators

@costinlotreanu
@edgar-avila
@kobyborali
@m1nhnv
@mrcaidev
@naufalk25
@oebelus
@sahilmaniyar
@shayanthenerd
@sliderkh
@stenbaek
@techhtml
@umutphp
@victorchao996
@wesleynepo
@zulkar29

License

CC0

Files

README.ja.md

Latest commit

History

README.ja.md

File metadata and controls

普通のHTMLの書き方

一般

DOCTYPEで始める

置き換えられるべきまたは旧式のDOCTYPEを使わない

XML宣言を使用しない

文字参照はできる限り使わない

&と<、>、"、'は名前文字参照を使ってエスケープする

制御文字や不可視文字は数値文字参照を使う

コメントではその内容の前後へ空白文字を置く

終了タグを省略しない

空要素の書き方を混ぜない

タグや属性値の前後へ空白文字を置かない

大文字・小文字を混ぜない

引用符を混ぜない

属性を2文字以上の空白文字で区切らない

真偽値を取る属性の値は省略する

名前空間は省略する

XML属性は使わない

data-*とMicrodata、RDFa Lite用の属性と通常の属性を混ぜない

デフォルトの暗黙のARIAセマンティックスを尊重する

文書要素

lang属性を追加する

lang属性の値はできる限り短くする

できる限りdata-*属性は避ける

文書メタデータ

title要素を書く

base要素を使わない

マイナーな参照先リソースのMIMEタイプを指定する

favicon.icoへリンクしない

apple-touch-iconへのリンクを書く

代替スタイルシートへtitle属性を追加する

URLにはlink要素を使う

文書の文字エンコーディングを指定する

置き換えられるべき文字エンコーディング指定フォーマットを使わない

最初に文字エンコーディングを指定する

UTF-8を使う

CSSのtype属性は省略する

style要素の中をコメントアウトしない

CSSとJavaScriptのタグを混ぜない

セクション

body要素を書く

hgroup要素のことは忘れる

address要素は連絡先情報にのみ使う

グルーピングコンテンツ

pre要素は改行で始めない

blockquote要素内でも適切な要素を使う

blockquote要素内に帰属情報を含めない

リスト項目は1行に1つずつ書く

ol要素ではtype属性を使う

dlを会話のために使わない

figcaption要素はfigure要素の最初か最後に置く

main要素を使う

できる限りdiv要素は避ける

テキストレベルセマンティックス

グループ化できるリンクは分割しない

リソースをダウンロードさせる場合はdownload属性を使う

relやhreflang、type属性を必要ならば使う

リンク文字列は明確にする

em要素を警告や注意に使わない

できる限りsやi、b、u要素を避ける

q要素内へ引用符は置かない

abbr要素へtitle属性を追加する

ruby要素は冗長にマークアップする

機械的に解釈可能でないtime要素ではdatetime属性を追加する

コードの言語はclass属性でlanguage-で始めることで指定する

できる限りkbd要素はシンプルにする

できる限りspan要素は使わない

br要素の後ろでは改行する

見た目だけのためにbr要素を使わない

編集

insやdel要素は他の要素をまたがせない

エンベディッドコンテンツ

picture要素ではフォールバックのためのimg要素を提供する

必要な時はimg要素へalt属性を追加する

`&`と`<`、`>`、`"`、`'`は名前文字参照を使ってエスケープする

`data-*`とMicrodata、RDFa Lite用の属性と通常の属性を混ぜない

`lang`属性を追加する

`lang`属性の値はできる限り短くする

できる限り`data-*`属性は避ける

`title`要素を書く

`base`要素を使わない

`favicon.ico`へリンクしない

`apple-touch-icon`へのリンクを書く

代替スタイルシートへ`title`属性を追加する

URLには`link`要素を使う

CSSの`type`属性は省略する

`style`要素の中をコメントアウトしない

`body`要素を書く

`hgroup`要素のことは忘れる

`address`要素は連絡先情報にのみ使う

`pre`要素は改行で始めない

`blockquote`要素内でも適切な要素を使う

`blockquote`要素内に帰属情報を含めない

`ol`要素では`type`属性を使う

`dl`を会話のために使わない

`figcaption`要素は`figure`要素の最初か最後に置く

`main`要素を使う

できる限り`div`要素は避ける

リソースをダウンロードさせる場合は`download`属性を使う

`rel`や`hreflang`、`type`属性を必要ならば使う

`em`要素を警告や注意に使わない

できる限り`s`や`i`、`b`、`u`要素を避ける

`q`要素内へ引用符は置かない

`abbr`要素へ`title`属性を追加する

`ruby`要素は冗長にマークアップする

機械的に解釈可能でない`time`要素では`datetime`属性を追加する

コードの言語は`class`属性で`language-`で始めることで指定する

できる限り`kbd`要素はシンプルにする

できる限り`span`要素は使わない

`br`要素の後ろでは改行する

見た目だけのために`br`要素を使わない

`ins`や`del`要素は他の要素をまたがせない

`picture`要素ではフォールバックのための`img`要素を提供する

必要な時は`img`要素へ`alt`属性を追加する

可能ならば`alt`属性は空にする

可能ならば`alt`属性は省略する

`iframe`要素の中は空にする

`map`要素の中はマークアップする

`audio`や`video`要素にフォールバックのためのコンテンツを提供する

見出しセルには`th`要素を使う

フォームコントロールは`label`要素で括る

可能ならば`for`属性は省略する

`input`要素では適切な`type`属性を使う

`input type="submit"`には`value`属性を追加する

`pattern`属性を持つ`input`要素には`title`属性を追加する

`placeholder`属性をラベル付けに使わない

`option`要素は1行に1つ書く

`progress`要素には`max`属性を追加する

`meter`要素では`min`及び`max`属性を追加する

`legend`要素は`fieldset`要素の最初に置く

JavaScriptでは`type`属性を省略する

`script`要素の中をコメントアウトしない

`script`要素を動的に生成するテクニックを使わない