モデルの説明をチェック

チェック ID: mathworks.jmaab.jc_0603

ガイドライン: jc_0603:モデルの説明

以下のモデル要素に対して、不統一な説明のフォーマットが指定されているモデル内のレイヤーを特定します。

このチェックには Simulink^® Check™ ライセンスが必要です。

このチェックには、MAB および JMAAB モデリングガイドラインで指定されているサブ ID に対応するサブチェックが含まれています。モデルアドバイザー構成エディターを使用して、実行するサブ ID (1 つ以上) を指定できます。

参考として、NA-MAAB および JMAAB モデリング標準組織で使用が推奨されている MAB ガイドラインサブ ID は以下のとおりです。

[説明ブロックタイプ] 入力パラメーターから説明ブロックタイプを選択し、[説明タグ] 入力パラメーターから説明タグを構成できます。[説明タグ] の形式は、コンマ区切りのタグをもつ string 型でなければなりません。

既定では、[説明ブロックタイプ] は [注釈] に設定され、[説明タグ] パラメーターは [Input:,Description:,Output:] に設定されています。

たとえば、既定の値 ([Input:,Description:,Output:]) の場合、モデル内の各レイヤーの説明のフォーマットは以下のようになっている必要があります。

Input: <入力情報>

Description: <モデルの説明>

Output: <出力情報>

ガイドラインサブ ID	条件	推奨アクション
jc_0603_a:各レイヤーでレイヤーの説明をチェックします。	モデル内の 1 つ以上のレイヤーにモデルの説明がない。	モデル内のすべてのレイヤーにモデルの説明を追加します。
jc_0603_b:レイヤーの説明の統一性をチェックします。	モデル内の 1 つ以上のレイヤーで統一されたモデルの説明のフォーマットをもっていない。	モデル内のすべてのレイヤーでモデルの説明を統一したフォーマットに維持します。