本節では、構文図の読み方について説明します。構文図のシンボル、図に含まれる項目 (キーワード、変数、区切り文字、演算子、フラグメント参照、オペランド) を定義し、これらの項目が含まれている構文例を示します。
構文図は、コマンド・ステートメントを構成する順序および部分 (オプションおよび引き数) を図で表します。水平線上のメインパスに沿って、右から左へ、また、上から下へ読んでいきます。
以下は、構文図に出現するシンボルです。
構文図には、多くのさまざまな項目が含まれています。構文項目には、以下のものがあります。
キーワード、変数、および演算子は、必須、オプショナル、またはデフォルトとして表示されます。フラグメント、区切り文字、および区切り文字は、必須またはオプショナルとして表示されます。
次の表では、構文例を示します。
項目 | 構文例 |
---|---|
必須項目
必須項目は、水平線のメインパス上に表示されます。下記の項目を指定しなければなりません。 |
>>-KEYWORD--required_item-------------------------------------->< |
必須の選択項目
必須の選択項目 (2 つ以上の項目) は、水平線のメインパス上に縦に重ねて表示されます。重なった項目からいずれか 1 つを選択しなければなりません。 |
>>-KEYWORD--+-required_choice1-+------------------------------->< '-required_choice2-' |
オプショナル項目
オプショナル項目は、水平線のメインパスの下に表示されます。 |
>>-KEYWORD--+---------------+---------------------------------->< '-optional_item-' |
オプショナルの選択項目
オプショナルの選択項目 (2 つ以上の項目) は、水平線のメインパスの下に縦に重ねて表示されます。重なった項目からいずれか 1 つを選択できます。 |
>>-KEYWORD--+------------------+------------------------------->< +-optional_choice1-+ '-optional_choice2-' |
デフォルト
デフォルト項目は、水平線のメインパスの上に表示されます。これ以外の項目 (必須またはオプショナル) は、水平線のメインパス上 (必須)、または水平線のメインパスの下 (オプショナル) に表示されます。下記の例は、オプショナル項目のあるデフォルトを表したものです。 |
.-default_choice1--. >>-KEYWORD--+------------------+------------------------------->< +-optional_choice2-+ '-optional_choice3-' |
変数
変数は、小文字のイタリックで表されます。これらは、名前または値を示します。 |
>>-KEYWORD--variable------------------------------------------->< |
反復可能な項目
水平線のメインパスの上を左に戻る矢印は、繰り返しの可能な項目を示しています。
反復可能な項目のグループの上を左に戻る矢印は、そのいずれか 1 つの項目を選択できるか、または単一項目を繰り返すことができることを示しています。 |
.-----------------. V | >>-KEYWORD----repeatable_item-+-------------------------------->< |