標準化された MATLAB 関数ヘッダーの使用をチェック

mathworks.hism.himl_0001

依存関係: Simulink® Check™

使用法: 高信頼性システムのモデル化

ガイドライン: himl_0001: 標準化された MATLAB 関数ヘッダーの使用

説明

このチェックを使用して、ローカル関数や参照されている MATLAB® ファイル内の関数を含め、モデル内のすべての MATLAB 関数を検査し、標準化された関数ヘッダーが含まれているかをチェックします。

このチェックは、関数ヘッダーに次の情報が存在することを確認します。

  • 関数名

  • 関数の説明

  • 入力変数の説明

  • 出力変数の説明

関数ヘッダーの定義方法の例を以下に示します。

  • % FUNCTION NAME:<Description of the function>

  • % Input variable 1: < Description of input variable 1>

  • % Input variable 2: < Description of input variable 2>

  • % Output variable 1: < Description of output variable 1>

チェックのパラメーター

モデル アドバイザー構成エディターを使用し、入力パラメーターを指定して解析の範囲を定義します。

パラメーター説明
Header format type

一貫性と明確性を維持するために関数ヘッダーが従う必要がある構造を指定します。

既定 (既定の設定) | カスタム

  • 既定 — 既定のヘッダー形式タイプ

  • カスタム — string として指定するカスタムのヘッダー形式タイプ。

Custom header format

コンマ区切りの string でカスタム ヘッダーの構造を指定します。このパラメーターは、[Header format type] が [カスタム] に設定されている場合にのみ有効になります。

Description, Input, Output (既定の設定)

モデル内で参照されている外部の .m ファイルをチェックします

モデル内で参照されている外部の MATLAB ファイルに対して実行するかどうかを指定します。

on (既定) | off

リンクに従う

ライブラリにリンクされたブロックの内容を解析に含めるかどうかを指定します。

オン (既定の設定) | オフ

マスク内を表示

マスクされたモデル要素を解析に含めるかどうかを指定します。

すべて (既定の設定) | なし | グラフィカル | 機能要件

  • すべて — すべてのマスクされたモデル要素をチェック解析に含めます。

  • なし — マスクされたモデル要素をチェック解析から除外します。

  • グラフィカル — マスクされたグラフィカル モデル要素のみをチェック解析に含めます。

  • 機能要件 — マスクされた機能的モデル要素のみをチェック解析に含めます。

推奨アクションと結果

チェックによってフラグが付けられた違反と、問題を修正するための推奨アクションを確認します。変更を適用した後、モデルを保存し、チェック解析を再実行します。

モデル化条件推奨アクション
MATLAB 関数で非標準の関数ヘッダーが使用されている。

次のガイドラインに従って、関数ヘッダーを関数に追加することを検討してください。

  • 有効な MATLAB コメントでなければならない。

  • 関数シグネチャの直後に配置しなければならない。

  • 指定された形式に従ったヘッダーがなければならない。

機能および制限事項

  • Simulink モデルによって直接参照されている関数のみが解析されます。

  • ブロックおよびチャートの対象外指定が許容されます。

  • アクティブなバリアント選択肢と非アクティブなバリアント選択肢の両方が解析されます。

  • モデルのコンパイルは不要です。

バージョン履歴

R2018b で導入

参考

トピック