code要素
要素名 | バージョン | 開始タグ | 終了タグ | 分類/親 | 中身 |
---|---|---|---|---|---|
code | 2.0, 2.x, 3.2, 4.0, X1.0, X1.1 | 必須 | 必須 | %phrase; | (%inline;)* |
共通属性 …… %coreattrs;, %i18n;, %events;
codeの解説
プログラムコードを表す要素です。文中で短いコードを紹介したりするときに用います。
スタイル指定がないときは、等幅フォントで表現されることが多いようです。
RFC1866 では以下のように説明されていました。
The <CODE> element indicates an example of code, typically rendered in a mono-spaced font. The <CODE> element is intended for short words or phrases of code; the <PRE> block structuring element (5.5.2, "Preformatted Text: PRE") is more appropriate for multiple-line listings. For example:
The expression <code>x += 1</code>
is short for <code>x = x + 1</code>.
複数行にわたるようなコードには pre などの方が適していると言っていますが、pre では意味づけができませんし、任意の場所での折り返しもできません。横幅が長いコードの場合にはあえてpreを使わない方が読みやすいこともあります。
- 「code要素」にコメントを書く