本页采用了机器翻译。点击此处可查看最新英文版本。

getSyntaxColoredCode

类: mlreportgen.report.MATLABCode
命名空间: mlreportgen.report

返回一个 DOM 对象，其中包含由 MATLABCode 报告器生成的代码的语法高亮显示版本

自 R2024b 起

全页展开

语法

syntaxColoredCode = mlreportgen.report.MATLABCode.getSyntaxColoredCode(reporter,report)

说明

syntaxColoredCode = mlreportgen.report.MATLABCode.getSyntaxColoredCode(reporter,report) 创建一个 DOM 对象，其中包含 reporter 指定的报告中 report 指定的代码的语法高亮版本。

输入参数

全部展开

MATLAB 代码报告器，指定为 mlreportgen.report.MATLABCode 对象。

报告，指定为报告对象。要创建 report 输入，请使用 mlreportgen.report.Report。

输出参量

全部展开

语法高亮的代码，以 DOM 对象形式返回。该表显示了为 MATLABCode 报告器指定的每个源返回的 DOM 对象类型和报告输出类型。

MATLAB 代码源报告类型DOM 对象
.mlxdocxmlreportgen.dom.EmbeddedObject
.mlx

  • html

  • html-file

mlreportgen.dom.RawText
.mlxpdfmlreportgen.dom.HTML
.m

  • html

  • html-file

  • docx

  • pdf

mlreportgen.dom.HTMLFile
使用 Content 属性直接指定的内容

  • html

  • html-file

  • docx

  • pdf

mlreportgen.dom.HTMLFile

示例

全部展开

打开实时脚本

使用 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);

版本历史记录

在 R2024b 中推出

另请参阅

| | | |