通常ファイル記述形式は、以下の構文により構成されます。なお、通常ファイルの記述形式に誤りがあった場合、構文エラーとなります。構文エラー時には、そのファイルに記述されているすべての内容が無効となります。
ステートメント
ステートメントとは、情報を設定するための行であり、以下の形式で記述します。
キーワード = 設定内容(\n)
ステートメントは、キーワード、「=」(イコール)、および設定内容から構成されています。ステートメントの記述規則を以下に示します。
ステートメントを省略する場合、対象ステートメントを削除するか、設定内容だけ省略します。
ステートメントを記述している行に、コメントは記述できません。
ステートメントを構成する情報の詳細を以下に説明します。
固有のキーワードを設定します。キーワードには、以下の規則があります。
キーワードは、対象行の先頭の英数字から「=」(イコール)の直前までを意味します。
キーワードには、英数字で始まる英数字とスペースで構成されている文字列を指定できます。
キーワード中に指定されている英字の大文字/小文字の区別はしません。
キーワード中にスペースを含むことができます。
キーワード中に連続したスペースが指定された場合、1つのスペースが指定されたものとみなされます。
対象行の先頭にスペースやタブが指定されている場合、そのスペースやタブは無視されます。
キーワードと設定内容の区切りをあらわす文字として使用し、以下の規則があります。
「=」は、必ず半角で指定する必要があります。
「=」の前後にスペースやタブが記述されている場合、そのスペースやタブは無視されます。
キーワードに対応する内容を設定します。設定内容には、以下の規則があります。
設定内容は、対象行の「=」の直後から指定できます。それ以降の「=」は設定内容に含まれる文字として扱われます。
設定内容の終わりはスペース、タブ、改行('\n')、またはEOFで示します。
設定内容に指定されている英字の大文字/小文字は区別されます。
設定内容は、1つの文字列しか指定できません。
設定内容中にスペースやタブが含まれる場合、二重引用符で括る必要があります。
設定内容を複数記述する場合、ステートメントを繰り返し記述します。
以下に正常なステートメントの設定例を示します。
Keyword= Information(\n) KEYWORD=Information(\n) KeyWord= Information (\n) Keyword = Information(\n) Keyword= Information(\n)
以上のステートメントは、すべて同じように解析されます。
This is a Keyword= "Information Area"(\n) THIS IS A KEYWORD="Information Area"(\n) This is a keyword= "Information Area" (\n) This is a Keyword= "Information Area"(\n)
以上のステートメントは、すべて同じように解析されます。
以下に、構文エラーとなるステートメントの例を示します。
# 設定内容が2つ指定されている(\n) Keyword= Information Area(\n) # ステートメントを記述している行にコメントが指定されている(\n) Keyword= Information # This is a Statement(\n) # 二重引用符で終了していない(\n) Keyword= "START Information. (\n) # キーワードと設定内容が2行で指定されている(\n) Keyword= "START Information. (\n) Information END" (\n)
また、登録されていないキーワードを指定した場合も構文エラーとなります。
コメント行
コメント行とは、通常ファイル中にコメント(注釈)を記述する時に使用します。
以下の形式で記述します。
# コメント(\n)
コメント行には、以下の規則があります。
コメント行の先頭に、#(シャープ)を指定します。
#は、半角文字で指定する必要があります。
空行
空行を記述することができ、解析時無視されます。