codeCompatibilityReport

コードの互換性レポートの作成

構文

codeCompatibilityReport

codeCompatibilityReport(names)

codeCompatibilityReport(___,'IncludeSubfolders',tf)

codeCompatibilityReport(cca)

説明

codeCompatibilityReport は、現在の作業フォルダーとサブフォルダーについてコードの互換性レポートを作成します。コードの互換性レポートは、MATLAB^® Web ブラウザーに開きます。MATLAB の新しいバージョンにアップグレードした後、このレポートを使用して、既存のコードの潜在的な互換性の問題を特定できます。

codeCompatibilityReport(names) は、names で指定されたファイルまたはフォルダーのレポートを作成します。

codeCompatibilityReport(___,'IncludeSubfolders',tf) は、サブフォルダーについてレポートするかどうかを指定します。既定では、サブフォルダーは解析に含まれます。この構文は、前述の構文にある任意の引数を指定して使用します。

codeCompatibilityReport(cca) は、CodeCompatibilityAnalysis オブジェクトとして指定された既存のコードの互換性結果からレポートを作成します。

例

現在のフォルダー内のコードに関するレポートを作成

現在のフォルダーとサブフォルダー内のコードについて、コードの互換性レポートを作成します。レポートは MATLAB Web ブラウザーに開きます。

codeCompatibilityReport

別のレポートを作成します。ただし、解析からサブフォルダーを除外します。

codeCompatibilityReport('IncludeSubfolders',false)

既存の解析結果のレポートを作成

現在の作業フォルダーとサブフォルダー内のコードについて、互換性解析結果を生成します。

r = analyzeCodeCompatibility;

その結果からレポートを作成します。レポートは MATLAB Web ブラウザーに開きます。

codeCompatibilityReport(r)

入力引数

names — 解析するファイルまたはフォルダーの名前

文字ベクトル | 文字ベクトルの cell 配列 | string スカラー | string 配列

解析するファイルまたはフォルダーの名前。文字ベクトル、文字ベクトルの cell 配列、string スカラーまたは string 配列として指定します。

ファイルの名前は有効な MATLAB コード ファイルまたはアプリ ファイル (.m、.mlx または .mlapp) でなければなりません。

例: '../thisFile.m'

例: {'folderA','folderB','fileA'}

データ型: char | string

tf — サブフォルダーの解析インジケーター

true (既定値) | false | 0 | 1

サブフォルダーの解析インジケーター。true、false、0 または 1 として指定します。既定では、analyzeCodeCompatibility は解析にサブフォルダーを含めます。サブフォルダーを除外するには、tf を false または 0 に設定します。

cca — コード互換性解析の結果

CodeCompatibilityAnalysis オブジェクト

コード互換性解析の結果。CodeCompatibilityAnalysis オブジェクトとして指定します。

詳細

コードの互換性レポート

コードの互換性レポートには、MATLAB の新しいバージョンへのコードのアップグレードに役立つ情報が含まれています。次のセクションがあります。

• 構文エラー — 構文エラーの詳細を示す表。たとえば、"~ を使用して値を無視することは、このコンテキスト内で許可されていません" があります。構文エラーによってコードは実行不能になります。構文エラーは MATLAB の新しいバージョンでは発生しませんが、互換性の解析に影響を与えます。

  この表には次の情報が含まれます。

  レポートの列	説明
  発生	ファイル内の構文エラーの総数。
  ファイル名	構文エラーが含まれているファイルの名前。

• 削除済みの機能 — 解析されたコードで使用されていて、かつ削除済みの機能の詳細を示す表。例: "'wavfinfo' は削除されました。代わりに 'AUDIOINFO' を使用してください。"

  この表には次の情報が含まれます。

  レポートの列	説明
  説明	チェックの説明。説明は、コード アナライザー メッセージと同じです。
  ドキュメンテーション	ドキュメンテーション内の詳細情報へのリンク。
  次で削除済み	機能が削除されたリリース。
  ファイル名	フラグの設定されたチェックを含むファイルの名前。
  行	ファイル内でチェックにフラグが設定された位置を示す行番号。

• 動作が変更された機能 — 解析されたコードで使用されていて、かつ動作が変更された機能の詳細を示す表。例: 'legend' は変更されたため、引数名がラベルではなく凡例のプロパティとして解釈される可能性があります。凡例のプロパティと同じ名前のラベルを含めるには、cell 配列または string 配列を使用してラベルを指定します。影響を受けたプロパティ名のリストは、ドキュメンテーションを参照してください。

  この表には次の情報が含まれます。

  レポートの列	説明
  説明	チェックの説明。説明は、コード アナライザー メッセージと同じです。
  ドキュメンテーション	ドキュメンテーション内の詳細情報へのリンク。
  これ以前に記述したコードに影響	機能が変更されたリリース。
  ファイル名	フラグの設定されたチェックを含むファイルの名前。
  行	ファイル内でチェックにフラグが設定された位置を示す行番号。

• エラーの原因となる可能性があるサポートされていない機能 — ここにリストされているファイルでは、サポートされていない機能、ドキュメンテーションにない機能、およびお客様による使用を想定されていない機能が使用されています。エラーおよび予期しない動作の変更を回避するため、ドキュメンテーションに記載された機能を使用するようにコードを更新してください。例: 'awtinvoke' はサポートされておらず、予告なしに変更されている可能性や、予告なしに削除される可能性があります。コードを適切に変更し、代わりに javaMethodEDT を使用してください。

  この表には次の情報が含まれます。

  レポートの列	説明
  説明	チェックの説明。説明は、コード アナライザー メッセージと同じです。
  ドキュメンテーション	ドキュメンテーション内の詳細情報へのリンク。
  ファイル名	フラグの設定されたチェックを含むファイルの名前。
  行	ファイル内でチェックにフラグが設定された位置を示す行番号。

• 削除予定の機能 — 解析されたコードで使用されていて、かつ将来のリリースで削除される機能の詳細を示す表。例: "'aviinfo' は将来のリリースで削除される予定です。代わりに 'VideoReader' を使用してください。"

  この表には次の情報が含まれます。

  レポートの列	説明
  説明	チェックの説明。説明は、コード アナライザー メッセージと同じです。
  ドキュメンテーション	ドキュメンテーション内の詳細情報へのリンク。
  ファイル名	フラグの設定されたチェックを含むファイルの名前。
  行	ファイル内でチェックにフラグが設定された位置を示す行番号。

• 動作が変更される予定の機能 — 解析されたコードで使用されていて、かつ将来のリリースで動作が変更される機能の詳細を示す表。例: "'interp1(...,'cubic')' は、3 次畳み込みを実行するように将来のリリースで変更される予定です。引き続き形状維持区分的 3 次内挿を使用する場合は、代わりに 'interp1(...,'pchip')' を使用してください。"

  この表には、[削除予定の機能] セクションと同じ列があります。

• コードを改善し得る新しい機能 — コードを更新することを検討してください。現在のコードは将来のリリースでも引き続き動作すると予想されますが、新しい機能が推奨されます。例: "プログラムでの DISPLAY の使用は推奨されません。代わりに DISP または FPRINTF を使用してください。"

  この表には次の情報が含まれます。

  レポートの列	説明
  説明	チェックの説明。説明は、コード アナライザー メッセージと同じです。
  ドキュメンテーション	ドキュメンテーション内の詳細情報へのリンク。
  ファイル名	フラグの設定されたチェックを含むファイルの名前。
  行	ファイル内でチェックにフラグが設定された位置を示す行番号。
  非表示	エディターでこのチェックを非表示にするかどうか、非表示にする場合はその方法。値が [none] の場合、チェックは非表示になりません。

• 実行されたチェックの完全なリスト — 指定したコードで実行されたチェックの情報を示す表。次の情報が含まれています。

  レポートの列	説明
  発生	解析されたコード内で、特定のチェックにフラグが設定された合計回数。
  ファイル	解析されたコード内で、特定のチェックにフラグが設定されたファイル数。
  説明	チェックの説明。たとえば、"このステートメントの前に、改行、セミコロンまたはコンマを使用してください"、または "STRMATCH は推奨されません。代わりに STRNCMP または VALIDATESTRING を使用してください" があります。説明は、コード アナライザー メッセージと同じです。
  重大度	チェックの重大度。たとえば、エラーや警告があります。エラーには、構文エラー、またはサポートの終了した機能が使用されていることを示すものがあります。警告には、コードに改善の余地があることを示すものがあります。
  識別子	MATLAB コード アナライザー メッセージの識別子。
  ドキュメンテーション	ドキュメンテーション内の詳細情報へのリンク。

• 解析されたファイルの完全なリスト — MATLAB がコードの互換性を解析したファイルのリスト。

ヒント

• レポートを保存するには、関数 codeCompatibilityReport を使用してレポートを生成する代わりに、CodeCompatibilityAnalysis オブジェクトを作成してそれを保存することができます。その後、これらの保存結果からレポートを生成できます。詳細については、既存の解析結果のレポートを作成を参照してください。

代替方法

現在のフォルダー ブラウザーで、現在の作業フォルダーとサブフォルダー内のコードに関するコードの互換性レポートを生成します。現在のフォルダー ブラウザーで、 をクリックするか、空白の領域を右クリックします。次に [レポート] 、 [コードの互換性レポート] を選択します。MATLAB コード互換性アナライザーを参照してください。

バージョン履歴

R2017b で導入

参考

コード互換性アナライザー | CodeCompatibilityAnalysis | analyzeCodeCompatibility

トピック

• MATLAB コード互換性アナライザー
• コード アナライザーを使用したエラーと警告についてのコードのチェック