表記上の規則 | 説明 |
---|---|
太字 | 太字は、通常、メニュー名、ダイアログ ボックス名、コマンド、オプション、ボタンなどのグラフィカル ユーザー インターフェイス要素を示します。太字は、標準的な印刷上の強調にも使用されます。 |
斜体 | 斜体は、適切な値に置き換える必要のある変数を示します。たとえば、user_name は実際のユーザー名に置き換えます。斜体は、マニュアル名など、標準的な印刷上の強調にも使用されます。 |
大文字 | 大文字のテキストは、通常、SQL 構文やコード例などを読みやすくするために使用します。オペレーティング システムによっては、大文字と小文字の区別には意味があります。そのような場合には、その説明でリテラル テキストが大文字または小文字である必要があるかどうかを記載します。 |
固定スペース フォント | 固定幅のテキストは、通常、構文例およびコード例を読みやすくするために使用します。また、コードの実行により返された結果やコマンド ラインに表示されるテキストにも使用します。テキストは、前後関係によって大文字または小文字で表示されます。 |
'、"、および “ ” | まっすぐな引用符は、一重引用符も二重引用符も、コードおよび構文の例に使用され、一重引用符または二重引用符が必要であることを示します。カールしている二重引用符は、標準的な印刷上の引用符に使用されます。 |
| | 縦棒は OR 区切り記号を表し、いずれか 1 つを選ぶ必要のある項目を示します。下記の山かっこの説明を参照してください。 |
[ ] | 角かっこはオプション項目を示します。かっこで囲まれていないコード構文は、必須の構文です。 |
< > | 山かっこは、かっこ内の 1 項目を選択する必要があることを示します。たとえば、<yes | no> と表記される場合は、"yes" または "no" のいずれかを指定する必要があります。 |
. . . | 省略記号は、前の項目を何度でも繰り返せることを示します。たとえば、[parameter...] は、parameter を繰り返せることを示します。省略記号に続くかっこは、かっこで囲まれた内容全部を繰り返せることを示します。 |
::= | 記号 ::= は、ある項目が別の項目用語で定義されていることを意味します。たとえば、a::=b は、項目 "a" が "b" で定義されていることを意味します。 |
%string% | Windows オペレーティング システムによって定義される変数です。string 部分は可変テキストを表します。パーセント記号はリテラル テキストです。 |
$string | Linux オペレーティング システムによって定義される環境変数です。string 部分は可変テキストを表します。ドル記号はリテラル テキストです。 |