ARM DS-5 デバッガユーザガイド : 7.12 ユースケーススクリプトの定義ブロック

7.12 ユースケーススクリプトの定義ブロック

各ユースケース定義ブロックは、ユースケースの開始を定義するための USECASE ヘッダ行で始める必要があります。このヘッダがないと、DS-5 ではスクリプトがユースケーススクリプトとして認識されません。

タグにはユースケースの内容を記述します。各タグは、他のテキストと区別するために、ドル（$）記号で囲まれています。 $Help$ タグを除き、すべてのタグは $<tag>$ <value> と定義されます。ユースケース定義ブロックでタグを定義する場合、指定できるのは 1 回だけです。1 つのユースケースでタグ名を重複させることはできません。

有効なユースケースに対して定義する必要があるのは、ユースケースのエントリポイントまたはメインメソッドを記述する $Run$ タグだけです。DS-5 コマンドラインでのユースケーススクリプトの検索時にわかりやすいヘルプを提供するために、各ユースケースで $Title$ タグと $Description$ タグも定義することをお勧めします。

実行

$Run$ タグでは、1 つのユースケースのエントリポイントの名前を指定します。コマンドラインでユースケースを実行すると、 $Run$ タグを使用してメソッドが呼び出されます。エントリポイントを定義する方法とメソッドの引数を追加指定する方法については、「7.13 ユースケーススクリプトの Run メソッドの定義」を参照してください。

例 7-2 例

...
$Run$ mainMethod
...

名称

$Title$ タグは、ユースケースの定義ブロック内でタイトルを指定します。これは、ユースケーススクリプトのタイトルである 1 行の文字列で、コマンドラインでユースケーススクリプトを検索すると表示されます。

例 7-3 例

...
$Title$ ユースケースのタイトル
...

［Description］

$Description$ タグは、ユースケースの定義ブロック内で説明を指定します。これは、このユースケースの説明である 1 行の文字列で、コマンドラインでユースケーススクリプトを検索すると表示されます。

例 7-4 例

...
$Description$ このユース ケースの説明
...

［オプション］（Options）

$Options$ タグは、ユースケーススクリプト内のメソッドを指定し、オプションのリストを取得するために呼び出すことができます。オプションの関数を定義する方法およびオプションのリストを作成する方法については、「7.14 ユースケーススクリプトの options メソッドの定義」を参照して下さい。

例 7-5 例

...
$Options$ myOptions
...

検証

$Validation$ タグは、ユースケースの定義ブロック内で検証メソッドを指定します。スクリプトの実行時に提供されるオプションを検証するには、これを指定する必要があります。検証関数を定義する方法については、「7.15 ユースケーススクリプトの Validation メソッドの定義」を参照して下さい。

例 7-6 例

...
$Validation$ myValidation
...

ヘルプ

$Help$ タグの使用方法は、他のタグの使用方法とわずかに異なります。 $Help$ タグではテキストを複数行のブロックで記述でき、ユーザがユースケーススクリプトについてのヘルプを要求したときに出力に表示されます。これは、使用法の説明、ユースケーススクリプトのパラメータ、または詳細なヘルプテキストに使用できます。

ヘルプテキストのブロックを定義するには、 $Help$ タグでブロックを囲みます。新しい行やスペースなどのフォーマットは $Help$ ブロックで保持されます。その他のタグの定義を含むすべては、 $Help$ ブロック内では消滅します。 $Help$ ブロックは、他のタグまたはコードを定義する前に完成させる必要があります。

例 7-7 例

$Help$
これはヘルプテキストの一部です
...
$Help$

非機密扱い	PDF 版	ARM DUI0446ZJ
Copyright © 2010–2016 ARM.All rights reserved.

7.12 ユース ケース スクリプトの定義ブロック

実行