×

[PR]この広告は3ヶ月以上更新がないため表示されています。
ホームページを更新後24時間以内に表示されなくなります。

「UT.Browser」の使用するためのコメントのコーディング規約

「UT.Browser」は、条件網羅を観点とした単体テスト項目表をソースのコメントから出力します。

ソースコメントは、テスト項目として出力する内容以外にも記述されます。
そこでテスト項目とするコメントについて規約を設ける必要があります。 ツールを使用するためのルールは、影響が小さくなるようにしました。

コメントの規約については2通りの設定の仕方があります。
VBのコメントの記述は、’シングルコーテーション以降は行コメントになります。

1.全コメントをテスト項目の出力対象とする方法(除外コメントを指定)

すべての'(シングルコーテーション)コメントを試験項目表の出力項目とする場合、''(2重シングルコーテーション)で始まる コメントをテスト項目の出力対象から除外するか選択できます。

全コメントを試験項目表出力対象とする場合の設定
メニュー:ツール → [オプション] → [試験項目対象コメント記号設定]の「全てのコメント」を指定します。
※「''(2重シングルコーテーション)のコメントは除外」を選択することができます。

全コメント出力対象

規約について

宣言と処理の記述のについて

  1. 定数、変数の宣言は、はじめに処理の内容を'(シングルコーテーション)コメントで記述し、個々の宣言は''(2重シングルコーテーション)コメントで記述します。
  2. 関数呼び出し等の処理で試験項目に出力するコメントは、ソースの前行または、ソース行に'(シングルコーテーション)コメントで記述します。
  3. 補足情報などの試験確認をしないコメントについては''(2重シングルコーテーション)コメントで記述します。
    ※「''(2重シングルコーテーション)のコメントは除外」がチェック済の場合

IF文の記述について

  1. IF文の前行に判定処理の内容を'(シングルコーテーション)コメントで記述します。
  2. THEN句、ELSE句の後に、条件判定の内容(~の場合)を'(シングルコーテーション)コメントで記述します。
  3. IF文内の処理について、試験項目として出力する場合、ソースの前行または、ソース行に'(シングルコーテーション)コメントで記述します。
  4. IF文内の処理について、補足情報などの試験確認をしないコメントについては''(2重シングルコーテーション)コメントで記述します。
    ※「''(2重シングルコーテーション)のコメントは除外」がチェック済の場合

SELECT~CASE文の記述について

  1. Select Case 比較元の式 の前行、または比較元の式の後ろに処理の内容を'(シングルコーテーション)コメントで記述します。
  2. 各場合分けは、Case 比較する式 の後に条件の内容を'(シングルコーテーション)でコメントを記述します。
  3. Case文内の処理について、確認項目として出力する場合、ソースの前行または、ソース行に'(シングルコーテーション)コメントで記述します。
  4. Case文内の処理について、補足情報などの試験確認を行わないコメントについては''(2重シングルコーテーション)コメントで記述します。
    ※「''(2重シングルコーテーション)のコメントは除外」がチェック済の場合

LOOP文の記述について

  1. Doループ
    • Do文の前行にループ処理の内容を'(シングルコーテーション)コメントで記述します。
    • Do(条件式)の後ろにループの条件を'(シングルコーテーション)コメントで記述します。
  2. Whileループ
    • WHILE文の前行にループ処理の内容を'(シングルコーテーション)コメントで記述します。
    • WHILE(条件式)後ろにループの条件を'(シングルコーテーション)コメントで記述します。
  3. Forループ
    • FOR文の前行にループ処理の内容を'(シングルコーテーション)コメントで記述します。
    • FOR(繰り返し開始)後ろにループの条件を'(シングルコーテーション)コメントで記述します。

  • ループ文内の処理について、確認項目として出力する場合、ソースの前行または、ソース行に'(シングルコーテーション)コメントで記述します。
    ループ文内の処理について、補足情報などの試験確認をしないコメントについては''(2重シングルコーテーション)コメントで記述します。
    ※「''(2重シングルコーテーション)のコメントは除外」がチェック済の場合

例外処理の記述について

  1. Try/Catch/Finallyの場合、Catch (エラー条件) の後ろに例外処理の条件を'(シングルコーテーション)コメントで記述します。
    Finallyは、確認条件が「共通処理」で固定出力されます。(コメントに寄りません)
    Catch内、Finally内の処理について、確認項目として出力する場合、ソースの前行または、ソース行に'(シングルコーテーション)コメントで記述します。 補足情報などの試験確認をしないコメントについては''(2重シングルコーテーション)コメントで記述します。
    ※「''(2重シングルコーテーション)のコメントは除外」がチェック済の場合

2.テスト項目として出力するコメントを指定する方法

項目の出力対象とするコメントを指定し、指定した対象のコメントで試験項目表を出力します。

指定するコメントについては、複数の形式を指定することができます。

指定コメントを試験項目表出力対象とする場合の設定
メニュー:ツール → [オプション] → [試験項目対象コメント記号設定]の「デフォルト指定」または、「ユーザー指定」を選択します。
「ユーザー指定」の場合、取得するコメントをカンマ区切りで指定します。

全コメント出力対象

規約について デフォルト指定('◇で始まるコメントを試験項目の対象とします)の場合

宣言と処理の記述のについて

  1. 定数、変数の宣言は、はじめに処理の内容を'◇でコメントを開始します。
  2. 関数呼び出し等の処理で試験項目に出力するコメントは、ソースの前行または、ソース行に'◇コメントでコメントを開始します。

IF文の記述について

  1. IF文の前行に判定処理の内容を'◇でコメントを開始します。
  2. THEN句、ELSE句の後に、条件判定の内容(~の場合)を'◇でコメントを開始、または'(シングルコーテーション)でコメントを記述します。
  3. IF文内の処理について、試験項目として出力する場合、ソースの前行または、ソース行に'◇でコメントを開始します。

SELECT~CASE文の記述について

  1. Select Case 比較元の式 の前行、または比較元の式の後ろに処理の内容を'◇でコメントを開始します。
  2. 各場合分けは、Case 比較する式 の後に条件の内容を'◇でコメントを開始、または'(シングルコーテーション)でコメントを記述します。
  3. Case文内の処理について、確認項目として出力する場合、ソースの前行または、その行に'◇でコメントを開始します。

LOOP文の記述について

  1. Doループ
    • Do文の前行にループ処理の内容を'◇でコメントを開始します。
    • Do(条件式)の後ろにループの条件を'◇でコメントを開始、または'(シングルコーテーション)コメントで記述します。
  2. Whileループ
    • WHILE文の前行にループ処理の内容を'◇でコメントを開始します。
    • WHILE(条件式)後ろにループの条件を'◇でコメントを開始、または'(シングルコーテーション)コメントで記述します。
  3. Forループ
    • FOR文の前行にループ処理の内容を'◇でコメントを開始します。
    • FOR(繰り返し開始)後ろにループの条件を'◇でコメントを開始、または'(シングルコーテーション)コメントで記述します。
  • ループ文内の処理について、確認項目として出力する場合、ソースの前行または、ソース行に'◇でコメントを開始します。

例外処理の記述について

  1. Try/Catch/Finallyの場合、Catch (エラー条件) の後ろに例外処理の条件を'◇でコメントを開始、または'(シングルコーテーション)コメントで記述します。
    Finallyは、確認条件が「共通処理」で固定出力されます。(コメントによりません)
    Catch内、Finally内の処理について、確認項目として出力する場合、ソースの前行または、ソース行に'◇でコメントを開始します。



最終更新日:2012年06月07日