1.2 ファイルの説明の記述形式

ファイルの説明の記述形式と使用する記号について説明します。

<この節の構成>
(1) 記述形式
(2) 使用する記号

(1) 記述形式

2章以降,ファイルの説明を次の形式で記述します。

形式
ファイルの記述形式を示します。
ファイルの格納先
ファイルの格納先を示します。
機能
ファイルの機能について説明します。
指定できるキー
ファイルの中で指定できるキーについて説明します。
指定できるパラメタ
ファイルの中で指定できるパラメタについて説明します。
記述例
ファイルの内容の記述例を示します。
注意事項
ファイルを設定または使用する際の注意事項を説明します。

 

参考
すべてのファイルで上記の項目をすべて説明しているわけではありません。また,上記以外に,各ファイルの固有情報を記載している場合があります。

(2) 使用する記号

ファイルの説明は次の表に示す記号および構文要素を使用して記述します。

表1-6 ファイルの説明で使用している記号

記号意 味
 |横に並べられた複数の項目に対する項目間の区切りを示し,「または」を意味します。
(例) A|B
 AまたはBを指定することを示します。
{   }この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ,記号|で区切られている場合は,そのうちの一つを選択します。
(例) {A|B|C}
 A,BまたはCのどれかを指定することを示します。
[ ]この記号で囲まれている項目は省略してもよいことを示します。複数の項目が横に並べて記述されている場合には,すべてを省略するか,記号{ }と同じくどれか一つを選択します。
(例1) [A]
 「何も指定しない」か「Aを指定する」ことを示します。
(例2) [B|C]
 「何も指定しない」か「BまたはCを指定する」ことを示します。
記述が省略されていることを示します。
(例) ABC…
 ABCの後ろに記述があり,その記述が省略されていることを示します。
< >この記号で囲まれている項目は,該当する要素やファイルなどを指定することを示します。
(例1) <プロパティ>
 プロパティを記述します。またはプロパティが表示されます。
(例2) <ファイル名>
 ファイル名を指定します。
 ...この記号の直前に示す記号を繰り返し,複数個指定できることを示します。
(例) <プロパティ>...
 プロパティは複数個,繰り返して指定できます。

注 すべて半角文字を使用してください。