mlreportgen.report.MATLABCode 类

命名空间: mlreportgen.report
超类: mlreportgen.report.Reporter

MATLAB 代码报告器

描述

使用 mlreportgen.report.MATLABCode 类的对象在报告中包含语法高亮的 MATLAB^® 代码。如果您需要 DOM 对象而不是 Report 对象，请将方法 getSyntaxColoredCode 与 mlreportgen.report.MATLABCode 对象结合使用。 (自 R2024b 起)

mlreportgen.report.MATLABCode 类是一个 handle 类。

类属性

HandleCompatible true

有关类属性的信息，请参阅类属性。

创建对象

描述

reporter = mlreportgen.report.MATLABCode 根据默认模板创建一个空的 MATLABCode 报告对象。您必须通过设置 FileName 属性来指定 MATLAB 代码文件，或者通过设置 Content 属性来指定代码内容。使用其他属性来指定报告器选项。

reporter = mlreportgen.report.MATLABCode(filename) 创建一个 MATLABCode 报告器，并将 FileName 属性设置为 filename。

示例

reporter = mlreportgen.report.MATLABCode(PropertyName=Value) 使用名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

`FileName` — MATLAB 代码文件的路径及文件名
`[]` (默认) | 字符向量 | 字符串标量

包含 MATLAB 代码的文件的路径和文件名，指定为字符向量或字符串标量。该文件可以具有 .m 或 .mlx 扩展名。如果您设置此属性，则 MATLABCode 报告器会将 Content 属性设置为包含指定文件中所含代码的字符串标量。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Content` — MATLAB 代码
`[]` (默认) | 字符向量 | 字符串标量

MATLAB 代码，指定为字符向量或字符串标量。仅当未设置 FileName 属性时才设置此属性。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`SmartIndent` — 是否对代码应用智能缩进
`0` (`false`) (默认) | `1` (`true`)

是否对代码应用智能缩进，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 对代码应用智能缩进。
0 (false) - 请勿对代码应用智能缩进。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: logical

`IncludeComplexity` — 是否包含代码复杂度
`0` (`false`) (默认) | `1` (`true`)

是否将代码复杂度、作为逻辑值 1 (true) 或 0 (false) 指定的纳入考虑范围。当您指定：

1 (true) - 列出 MATLAB 代码中每个函数的麦凯布循环复杂度。
0 (false) - 省略每个函数的麦凯布循环复杂度。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: logical

`ComplexityReporter` — 代码复杂度报告器
`mlreportgen.report.BaseTable`

代码复杂度报告器，指定为 mlreportgen.report.BaseTable 对象。BaseTable 报告器用于报告和格式化代码复杂度表格数据。该属性的默认值为 BaseTable 对象，其中 TableStyleName 属性设置为 "MATLABCodeTable"，其他属性设置为默认值。您可以通过自定义默认报告器或将其替换为自定义 BaseTable 报告器来自定义表的外观。您在默认或替换 BaseTable 报告器的 Title 属性中指定的任何内容都会出现在生成的报告的标题之前。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

该报告器的模板来源，以下列方式之一指定：

字符向量或字符串标量，指定包含此报告器模板的文件的路径
此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告
文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

指定的模板必须与您追加此报告器的报告类型相同。例如，对于 Microsoft^® Word 报告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`
`Dependent`	`true`

`TemplateName` — 此报告器的模板名称
`"MATLABCode"` (默认) | 字符向量 | 字符串标量

此报告器的模板名称，指定为字符向量或字符串标量。该报告器的模板必须位于该报告器的模板源 (TemplateSrc) 的模板库中。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标在输出报告中紧接着此报告器的内容。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

方法

全部展开

公共方法

方法	用途
`getSyntaxColoredCode`	返回一个 DOM 对象，其中包含由 `MATLABCode` 报告器生成的代码的语法高亮显示版本
`mlreportgen.report.MATLABCode.createTemplate`	创建报告器模板 `template = createTemplate(templatePath,templateType)` 在 `templatePath` 指定的位置，为 `templateType` 指定的报告类型创建默认模板的副本。您可以使用复制的模板作为起点，为您的报告设计自定义的报告模板。输入参量 `templatePath` - 模板文件的目标路径和文件名，指定为字符向量或字符串标量。 `templateType` - 模板类型，指定为 `"html"`、`"docx"` 或 `"pdf"` 返回值 `template` - 模板副本的路径和文件名，以字符串标量形式返回。有关详细信息，请参阅 `Reporter` 类的 `mlreportgen.report.Reporter.createTemplate` 方法。
`mlreportgen.report.MATLABCode.customizeReporter`	从 `mlreportgen.report.MATLABCode` 类创建报告器 `classPathOut = customizeReporter(classPath)` 创建一个报告类定义文件，该文件在 `classPath` 指定的位置定义 `mlreportgen.report.MATLABCode` 的子类。该方法将默认报告器模板复制到包含类定义文件的文件夹下的 `resources/templates` 子文件夹中。您可以使用类定义文件作为起点来设计自定义报告器类。输入参量 `classPath` - 新类定义文件的路径和名称，指定为字符向量或字符串标量返回值 `classPathOut` - 新类的路径和文件名，以字符串标量形式返回有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `mlreportgen.report.Reporter.customizeReporter` 方法。
`mlreportgen.report.MATLABCode.getClassFolder`	获取包含 `mlreportgen.report.MATLABCode` 类定义文件的文件夹位置 `path = getClassFolder` 返回包含类定义文件的文件夹的路径。返回值 `path` - 类定义文件的位置，以字符向量形式返回。有关详细信息，请参阅 `Reporter` 类的 `mlreportgen.report.Reporter.getClassFolder` 方法。
`copy`	创建报告器对象的副本，并对属性值进行深拷贝 `copiedObj = copy(reporterObj)` 返回指定报告对象的副本。返回的副本包含引用报告器、DOM 对象或 `mlreportgen.report.ReporterLayout` 对象的 `reporterObj` 的任何属性值的深拷贝。因此，您可以修改原始对象或新对象的属性，而不会影响其他对象。输入参量 `reporterObj` - 要复制的报告器对象，指定为报告器类的对象返回值 `copiedObj` - 报告器的副本，以报告器类对象形式返回有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `copy` 方法。
`getImpl`	获取报告器的实现 `impl = getImpl(reporter,report)` 返回在将报告器 `reporter` 追加到报告 `report` 时实现该报告器的文档对象模型 (DOM) 对象。注意调用此方法后，您无法再向报告器添加内容。输入参量 `reporterObj` - 报告器对象，指定为 `mlreportgen.report.Reporter` 的对象或 `mlreportgen.report.Reporter` 的子类的对象 `report` - 报告，指定为 `mlreportgen.report.Report` 对象返回值 `impl` - 实现对象，以 DOM 对象形式返回。有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `getImpl` 方法。

示例

全部折叠

在报告中包含语法突出显示的 MATLAB 函数

打开实时脚本

报告函数 myAdd.m 的语法高亮代码。

创建报告。

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

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

创建一个章节。

chap = Chapter("The myAdd Function");

创建一个 MATLABCode 报告器，报告 myAdd.m 的内容。

mCode = MATLABCode("myAdd.m");

将报告器添加到章节，将章节添加到报告中。如果您需要向 DOM 对象添加语法高亮的 MATLAB 代码，请参阅将语法高亮的 MATLAB 代码 DOM 对象添加到报告中。

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

关闭报告并打开查看器。

close(rpt);
rptview(rpt);

以下是报告中语法突出显示的代码。

将语法高亮的 MATLAB 代码 DOM 对象添加到报告中

打开实时脚本

使用 getSyntaxColoredCode 方法从 MATLABCode 报告器读取的代码中创建 DOM 对象。getSyntaxColoredCode 根据报告格式和 MATLAB 代码的来源返回不同的 DOM 对象类型。

MATLAB 代码源	报告格式	DOM 对象
.mlx	DOCX	`mlreportgen.dom.EmbeddedObject`
.mlx	HTML HTML 文件	`mlreportgen.dom.RawText`
.mlx	PDF	`mlreportgen.dom.HTML`
.m	DOCX HTML HTML 文件 PDF	`mlreportgen.dom.HTMLFile`
使用 `Content` 属性直接指定的内容	DOCX HTML HTML 文件 PDF	`mlreportgen.dom.HTMLFile`

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

创建报告。

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

创建一个章节。

chap = Chapter("The myAdd Function");

创建一个 DOM 表。

table = mlreportgen.dom.Table(2);
table.Style = {...
    Border("solid"),...
    ColSep("solid"),...
    RowSep("solid"),...
    Width("100%")...
    };
table.TableEntriesVAlign = "middle";

创建表行。

tr = TableRow();

创建第一个表条目并向其中追加一些内容。

entry11 = TableEntry();
append(entry11,"Addition");

为 MATLAB 代码创建另一个表条目。

entry12 = TableEntry();

创建一个 MATLABCode 报告器，报告 myAdd.m 的内容。

mCode = MATLABCode("myAdd.m");

根据报告结果创建一个 DOM 对象。

synatxColorCode = getSyntaxColoredCode(mCode,rpt)

synatxColorCode = 
  HTMLFile with properties:

    KeepInterElementWhiteSpace: 0
                EMBaseFontSize: 12
                       HTMLTag: 'div'
                     StyleName: []
                         Style: {1×0 cell}
              CustomAttributes: []
                        Parent: []
                      Children: [1×1 mlreportgen.dom.Container]
                           Tag: 'dom.HTMLFile:50558'
                            Id: '50558'

将代码的语法颜色呈现添加到表条目中。

append(entry12,synatxColorCode);

将表条目附加到表行，并将表行附加到表。

append(tr,entry11);
append(tr,entry12);
append(table,tr);

将表添加到章节中，将章节添加到报告中。

append(chap,table);
append(rpt,chap);

关闭报告并打开查看器。

close(rpt);
rptview(rpt);

版本历史记录

在 R2021a 中推出

全部展开

R2024b: 将 MATLAB 语法高亮内容添加到报告

使用方法 getSyntaxColoredCode 以编程方式将 MATLAB 语法高亮内容作为 DOM 对象添加到报告中。该方法从指定的 .mlx 或 .m 文件生成适合报告输出类型的 DOM 对象。

另请参阅

mlreportgen.report.Report | mlreportgen.report.Reporter | mlreportgen.report.MATLABVariable | mlreportgen.report.BaseTable | checkcode

mlreportgen.report.MATLABCode 类

描述

类属性

创建对象

描述

属性

FileName — MATLAB 代码文件的路径及文件名 [] (默认) | 字符向量 | 字符串标量

属性：

Content — MATLAB 代码 [] (默认) | 字符向量 | 字符串标量

属性：

SmartIndent — 是否对代码应用智能缩进 0 (false) (默认) | 1 (true)

属性：

IncludeComplexity — 是否包含代码复杂度 0 (false) (默认) | 1 (true)

属性：

ComplexityReporter — 代码复杂度报告器 mlreportgen.report.BaseTable

属性：

TemplateSrc — 此报告器的模板来源 字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

属性：

TemplateName — 此报告器的模板名称 "MATLABCode" (默认) | 字符向量 | 字符串标量

属性：

LinkTarget — 此报告器的超链接目标 [] (默认) | 字符向量 | 字符串标量 | mlreportgen.dom.LinkTarget 对象

属性：

方法

公共方法

示例

在报告中包含语法突出显示的 MATLAB 函数

将语法高亮的 MATLAB 代码 DOM 对象添加到报告中

版本历史记录

R2024b: 将 MATLAB 语法高亮内容添加到报告

另请参阅

主题

`FileName` — MATLAB 代码文件的路径及文件名
`[]` (默认) | 字符向量 | 字符串标量

`Content` — MATLAB 代码
`[]` (默认) | 字符向量 | 字符串标量

`SmartIndent` — 是否对代码应用智能缩进
`0` (`false`) (默认) | `1` (`true`)

`IncludeComplexity` — 是否包含代码复杂度
`0` (`false`) (默认) | `1` (`true`)

`ComplexityReporter` — 代码复杂度报告器
`mlreportgen.report.BaseTable`

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

`TemplateName` — 此报告器的模板名称
`"MATLABCode"` (默认) | 字符向量 | 字符串标量

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象