Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Web/HTML/Comments を新規翻訳 #24020

Merged
merged 2 commits into from
Oct 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions files/ja/web/html/comments/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: コメント
slug: Web/HTML/Comments
l10n:
sourceCommit: e4ec417e0f84b2fbd23fb37b236047fbdd215b68
---

{{CSSRef}}

HTML の**コメント**は、マークアップに説明メモを追加したり、文書内の特定の箇所をブラウザーに解釈させないようにしたりするために使用します。

コメントは文字列 `<!--` で始まり、文字列 `-->` で終わります。通常、その間にはテキストが含まれます。このテキストは文字列 `>` または `->` で始めることはできません。また、文字列 `-->` または `--!>` を含むことも、文字列 `<!-` で終わることもできません。ただし、`<!` は許可されています。

ブラウザーはコードをレンダリングする際にコメントを無視します。言い換えれば、コメントはページ上には表示されず、コード上にのみ表示されます。HTML コメントは、コードやロジックについて役立つメモを書く方法です。

上記のことは、[XML](/ja/docs/Web/XML) コメントにも当てはまります。さらに XML、例えば [SVG](/ja/docs/Web/SVG) や [MathML](/ja/docs/Web/MathML) マークアップなどでは、コメントに文字列 `--` を格納することはできません。

コメントは単一の行で使用することも、複数行にわたって使用することもできます。コメントは以下の場所で使用することができます。

- {{Glossary("doctype")}} の前後
- {{HTMLElement("html")}} 要素の前後
- ほとんどの要素コンテンツ。ただし、{{HTMLElement("script")}}, {{HTMLElement("style")}}, {{HTMLElement("title")}}, {{HTMLElement("textarea")}} は、コンテンツを生のテキストとして解釈するため不可。

> **メモ:** `<script>` 要素は HTML コメントを持たず、[JavaScript コメント](/ja/docs/Web/JavaScript/Reference/Lexical_grammar#コメント)を使用すべきですが、JavaScript に対応していない古いブラウザーではコンテンツがテキストとして表示されないように、スクリプトコンテンツ全体を HTML コメントで囲むという慣習が残っていました。これは現在では [JavaScript 自体の古い機能](/ja/docs/Web/JavaScript/Reference/Deprecated_and_obsolete_features#html_コメント)であり、これに頼るべきではありません。

## 構文

```html
<!-- コメント -->
```

## 例

```html
<!-- 1 行コメント -->

<!--
複数行に
展開された
コメント
-->

<!-- 下記のコメントは、内部の
HTML を無効にしている -->
<!--
<p>
このコンテンツは表示されません。
</p>
-->
```

## メモ

HTML コメントはコンテンツとしてのみ許可されています。タグ内、例えば [HTML 属性](/ja/docs/Glossary/Attribute)の前に使用することはできません。

`<!-- -->` コメント構文を使用するほとんどのプログラミング言語と同様に、コメントはネスト(入れ子)にすることができません。言い換えれば、`<!--` の後に出現した最初の `-->` が、コメントが閉じられたことを意味します。

コメントは `<` で始まり `>` で終わりますが、コメントは HTML 要素ではありません。

## 仕様書

{{Specifications}}

## 関連情報

- [JavaScript のコメント](/ja/docs/Web/JavaScript/Reference/Lexical_grammar#コメント)
- [CSS のコメント](/ja/docs/Web/CSS/Comments)
- {{domxref("Comment")}} API(`Comment` は {{domxref("Node")}} を継承)