CasePlayer2の仕様書のうち、下の6つは、ソースファイルを登録するだけで簡単に作成できます。ソースが完成している必要はなく、ヘッダファイルが無い場合や開発途中のソースコードの場合で、コンパイルエラー、リンクエラーを発生するようなソースでも対応可能です。ソースのif文やswitch文、for文、while文などのソースの構造を解析し、チャート化することが可能です。
技術・サポート情報
CasePlayer2の仕様書のうち、下の6つは、ソースファイルを登録するだけで簡単に作成できます。ソースが完成している必要はなく、ヘッダファイルが無い場合や開発途中のソースコードの場合で、コンパイルエラー、リンクエラーを発生するようなソースでも対応可能です。ソースのif文やswitch文、for文、while文などのソースの構造を解析し、チャート化することが可能です。
ソース01から生成した、関数etos()のフローチャート
※分岐状態の表示、ソースに記述したコメントの取り込まれ方をご確認下さい。
関数etos()のフローチャートサンプルです。
ソース01内の関数etos()の、モジュール(関数)仕様書
ソースコードサンプルから生成された、関数etos()のモジュール仕様書です。関数の上にあるコメントブロックが、仕様書の概要説明書に適用されます。その他、ソース内のコメントが、どのように適用されるか、ご確認下さい。
・概要説明欄:関数の直ぐ上にあるコメントブロック(/* */で囲んだ範囲)が適用されます。
・引数:引数部分を改行して、各行にコメントを記述すると、仕様書の引数コメントに適用されます。
・ローカル変数:変数の右に付けたコメントが適用されます。
・戻り値:引数のコメントを仕様書に反映させるには、CasePlayer2専用の記述を追加する必要があります。
このため、 戻り値の説明は、上記の「概要説明欄」に含めて記述するか、仕様書生成後に、仕様書に直接書き込む方法をお薦めしています。(仕様書に書き込んだ記述は、仕様書を再生成した場合も保持されます。)
(例)戻り値のコメントを仕様書に埋め込むための特殊な記述。これを関数のコメントヘッダに入れる必要有り。
/* ++module
++arguments
[戻り値のコメントを記入します。]
++end_module */
また、詳細解析機能により、この関数が使用している外部変数(グローバル変数)と、その参照関係が示されます。(参照している外部変数一覧、代入している外部変数一覧)
ソース01内の関数etos()を含む、プロジェクト全体のモジュール構造図(関数の呼出階層図)
ソースコードサンプルの関数を含む、プロジェクト全体のモジュール構造図(関数呼出相関図)です。1つのボックスが1つの関数に対応しており、関数が呼び出した関数を、階層的に右側に示しています。
実線のボックスは、プロジェクト内にソースコードが存在する関数、点線は、ライブラリなどのようにプロジェクト内に関数の実体ソースがないものを示しています。
ソース01内の構造体code_tableの仕様書
サンプルコード内に定義されている構造体「code_table」の仕様書です。構造体定義の上にあるコメントが、仕様書の概要説明に適用されます。メンバーの横にあるコメントが、要素一覧のコメント欄に適用されます。
ソース01内の関数etos()を含む、プロジェクト全体のモジュール(関数)一覧
サンプルコード内に定義されている関数 etos() を含む、プロジェクト全体に含まれるモジュール(関数)の一覧です。各項目の行を右クリックすることで、ソースコード上の関数の定義位置へ移動することができます。
ソース01内のソース内の構造体code_tableを含む、プロジェクト全体の構造体一覧
サンプルコード内に定義されている構造体code_tableを含む、プロジェクト全体に含まれる構造体の一覧です。各項目の行を右クリックすることで、ソースコード上の構造体の定義位置へ移動することができます。