ホーム > ユーザーサポート > FAQ カバレッジマスターwinAMS > 仕様書サンプルナビゲータ > モジュール仕様書出力

CasePlayer2 仕様書出力サンプル ナビゲータ 【仕様書生成モード】


モジュール仕様書出力 : 関数 etos()

ソースコードサンプルから生成された、関数etos()のモジュール仕様書です。関数の上にあるコメントブロックが、仕様書の概要説明書に適用されます。その他、ソース内のコメントが、どのように適用されるか、ご確認下さい。

・概要説明欄 : 関数の直ぐ上にあるコメントブロック(/* */で囲んだ範囲)が適用されます。
・引数 : 引数部分を改行して、各行にコメントを記述すると、仕様書の引数コメントに適用されます。
・ローカル変数 : 変数の右に付けたコメントが適用されます。
・戻り値 : 引数のコメントを仕様書に反映させるには、CasePlayer2専用の記述を追加する必要があります。
   このため、 戻り値の説明は、上記の「概要説明欄」に含めて記述するか、仕様書生成後に、仕様書に直接書き込む
   方法をお薦めしています。(仕様書に書き込んだ記述は、仕様書を再生成した場合も保持されます。)

(例)戻り値のコメントを仕様書に埋め込むための特殊な記述。これを関数のコメントヘッダに入れる必要有り。
   /* ++module<etos>
   ++arguments
   <int><>[戻り値のコメントを記入します。]
   ++end_module */





また、詳細解析機能により、この関数が使用している外部変数(グローバル変数)と、その参照関係が示されます。(↓参照している外部変数一覧、↓代入している外部変数一覧)

モジュール仕様書

参考情報・リンク