Main Content

mlreportgen.report.MATLABCode クラス

名前空間: mlreportgen.report

MATLAB コード レポーター

R2021a 以降

このページをすべて展開する

説明

mlreportgen.report.MATLABCode クラスのオブジェクトを使用して、構文を強調表示した MATLAB® コードをレポートに含めます。

mlreportgen.report.MATLABCode クラスは handle クラスです。

クラス属性

HandleCompatible
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

reporter = mlreportgen.report.MATLABCode() は、既定のテンプレートに基づいて空の MATLABCode レポーター オブジェクトを作成します。FileName プロパティを設定して MATLAB コード ファイルを指定するか、Content プロパティを設定してコード コンテンツを指定しなければなりません。レポーター オプションを指定するには、他のプロパティを使用します。

例

reporter = mlreportgen.report.MATLABCode(filename) は、FileName プロパティが filename に設定された MATLABCode レポーターを作成します。

reporter = mlreportgen.report.MATLABCode(Name=Value) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順番で指定できます。

プロパティ

すべて展開する

MATLAB コードを含むファイルのパスとファイル名。文字ベクトルまたは string スカラーとして指定します。ファイルは .m または .mlx の拡張子をもつことができます。このプロパティを設定すると、MATLABCode レポーターは Content プロパティを、指定されたファイルに格納されているコードを含む string スカラーに設定します。

属性:

GetAccess
public
SetAccess
public
Dependent
true
NonCopyable
true

MATLAB コード。文字ベクトルまたは string スカラーとして指定します。FileName プロパティが設定されていない場合にのみ、このプロパティを設定します。

属性:

GetAccess
public
SetAccess
public
Dependent
true
NonCopyable
true

コードにスマート インデントを適用するかどうか。true または false として指定します。

属性:

GetAccess
public
SetAccess
public

コード複雑度を含めるかどうか。true または false として指定します。値が true の場合、レポートには、MATLAB コードに含まれる各関数の McCabe 循環的複雑度が含められます。

属性:

GetAccess
public
SetAccess
public

コード複雑度レポーター。mlreportgen.report.BaseTable オブジェクトとして指定します。BaseTable レポーターは、コード複雑度の表形式データをレポートおよび書式設定するために使用されます。このプロパティの既定値は、TableStyleName プロパティが "MATLABCodeTable" に設定され、その他のプロパティが既定値に設定された BaseTable オブジェクトです。既定のレポーターをカスタマイズするか、カスタム BaseTable レポーターに置き換えることで、テーブルの外観をカスタマイズできます。既定または代替の BaseTable レポーターの Title プロパティで指定したコンテンツは、生成レポート内でタイトルの前に表示されます。

属性:

GetAccess
public
SetAccess
public

このレポーターのテンプレートのソース。次のオプションのいずれかとして指定します。

  • このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー

  • テンプレートがこのレポーターのために使用される、またはテンプレート ライブラリがこのレポーターのテンプレートを含むレポーターまたはレポート

  • テンプレートがこのレポーターのために使用される、またはテンプレート ライブラリがこのレポーターのテンプレートを含む DOM ドキュメントまたはドキュメント パーツ

指定したテンプレートは、このレポーターが追加されるレポートと同じタイプにしなければなりません。たとえば、Microsoft® Word レポートでは、TemplateSrc は Word レポーター テンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプに既定のレポーター テンプレートを使用します。

このレポーターのテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーターのテンプレートは、このレポーター用のテンプレート ソース (TemplateSrc) のテンプレート ライブラリになければなりません。

このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルもしくは string スカラー、または mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラー値は LinkTarget オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前にあります。

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

関数 myAdd.m の構文を強調表示したコードをレポートします。

レポートを作成します。

import mlreportgen.dom.*
import mlreportgen.report.*

rpt = Report("MyReport","pdf");

章を作成します。

chap = Chapter("The myAdd Function");

myAdd.m のコンテンツをレポートする MATLABCode レポーターを作成します。

mCode = MATLABCode("myAdd.m");

レポーターを章に追加し、章をレポートに追加します。

append(chap,mCode);
append(rpt,chap);

レポートを閉じて、ビューアーを開きます。

close(rpt);
rptview(rpt);

レポートにおいて、構文を強調表示したコードは次のようになります。

バージョン履歴

R2021a で導入

参考

| | |