関数ヘッダーのチェック

チェック ID: mathworks.jmaab_v6.mp_0032

ガイドライン: mp_0032: 関数ヘッダー情報

説明

関数ヘッダーに入力パラメーターで指定された記述項目が含まれているかどうかをチェックします。

このチェックは、以下のターゲット コンポーネントに適用されます。

  • Simulink® 内の MATLAB Function ブロック。

  • Stateflow® チャート内の MATLAB® 関数。

  • モデルで参照されている外部 MATLAB ファイル。

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

チェックのパラメーター化

JMAAB モデリング ガイドラインはサブ ID を 1 つのみ提供するため、このチェックにはサブチェックは含まれません。

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

  • JMAAB — a

[モデル内で参照されている外部の .m ファイルをチェックします] を選択して、.m 拡張子のファイルを解析に含めます。既定では、このチェック ボックスは選択されています。

[記述項目] ボックスに、関数ヘッダーでチェックする記述項目を、パイプ記号 ("|") で区切って入力します。記述項目は大文字と小文字が区別されず、関数ヘッダー内に任意の順序で配置できます。既定値は Overview|Processing content|Arguments|Return value|change history です。

関数ヘッダーの各記述項目は個別の行に配置されている必要があり、特殊文字を含めることはできません。たとえば、入力パラメーター [記述項目] の既定値の場合、次のヘッダーに対してはこのチェックは潜在的な問題のフラグを付けません。

% Overview
%    sample program
% Processing content
%    Add arg1 and foo and return the value
% Arguments
%    arg1: First term
% Return Value
%    ret: Addition result
% Change History
%     05/24/2022 - added new comments

[記述項目] の既定値では、次の関数ヘッダーに対しては、このチェックによりフラグが付けられます。

% Overview --
%    sample program
% Processing content Add arg1 and foo and return the value
% Arguments    arg1: First term
% Return Value
%    ret: Addition result
% Change History !
%     05/24/2022 - added new comments

結果と推奨アクション

条件推奨アクション
1 つ以上の関数ヘッダーに、指定された記述項目が含まれていない。[記述項目] 入力パラメーターで指定された記述項目を関数ヘッダーに含めます。

機能および制限事項

  • ライブラリにリンクされたブロックの内容を解析します。既定では、入力パラメーター [リンクに従う] は [オン] に設定されます。

  • マスク サブシステムの内容を解析します。既定では、入力パラメーター [マスク内を表示] は [すべて] に設定されます。

  • ライブラリ モデルで実行されます。

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

  • Truth Table (Stateflow) ブロックと Stateflow 遷移表がサポートされています。

参考