Exponenta Banner
exponenta event banner

mlreportgen.report.MATLABCode класс

Пакет: mlreportgen.report

Репортер кода MATLAB

развернуть все на странице

Описание

Использование объекта mlreportgen.report.MATLABCode для включения в отчет выделенного синтаксисом кода MATLAB ®.

mlreportgen.report.MATLABCode класс является handle класс.

Атрибуты класса

HandleCompatible
true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

reporter = mlreportgen.report.MATLABCode() создает пустой MATLABCode на основе шаблона по умолчанию. Необходимо указать файл кода MATLAB, установив FileName или укажите содержимое кода, установив Content собственность. Используйте другие свойства для задания параметров репортера.

пример

reporter = mlreportgen.report.MATLABCode(filename) создает MATLABCode репортер с FileName свойство имеет значение filename.

reporter = mlreportgen.report.MATLABCode(Name,Value) задает свойства, используя пары имя-значение. Можно указать несколько аргументов пары имя-значение в любом порядке. Заключите каждое имя свойства в одинарные или двойные кавычки.

Свойства

развернуть все

Путь и имя файла, содержащего код MATLAB, указанный как вектор символов или скаляр строки. Файл может иметь .m или .mlx расширение. Если задать это свойство, MATLABCode репортер устанавливает Content для строкового скаляра, содержащего код, содержащийся в указанном файле.

Атрибуты:

GetAccess
public
SetAccess
public
Dependent
true
NonCopyable
true

Код MATLAB, заданный как вектор символа или скаляр строки. Установить это свойство, только если FileName свойство не задано.

Атрибуты:

GetAccess
public
SetAccess
public
Dependent
true
NonCopyable
true

Применять ли смарт-отступы к коду, указанному как true или false.

Атрибуты:

GetAccess
public
SetAccess
public

Включить ли сложность кода, указанное как true или false. Если значение равно trueотчет включает цикломатическую сложность Маккейба каждой функции, которую содержит код MATLAB.

Атрибуты:

GetAccess
public
SetAccess
public

Репортер сложности кода, указанный как mlreportgen.report.BaseTable объект. BaseTable reporter используется для отчета и форматирования табличных данных сложности кода. Значением по умолчанию этого свойства является BaseTableобъект с TableStyleName свойство имеет значение "MATLABCodeTable" а для других свойств установлены значения по умолчанию. Можно настроить внешний вид таблицы, настроив репортер по умолчанию или заменив его пользовательским BaseTable репортер. Любое содержимое, указанное в Title свойства по умолчанию или замены BaseTable репортер появляется перед заголовком в созданном отчете.

Атрибуты:

GetAccess
public
SetAccess
public

Источник шаблона для этого репортера, указанный одним из следующих способов:

  • Вектор символов или строковый скаляр, указывающий путь к файлу, содержащему шаблон для этого репортера

  • Репортер или отчет, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

  • Документ DOM или деталь документа, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

Указанный шаблон должен быть того же типа, что и отчет, к которому добавлен этот репортер. Например, для отчета Microsoft ® Word :TemplateSrc должен быть шаблоном репортера Word. Если TemplateSrc пустое свойство, этот репортер использует шаблон репортера по умолчанию для типа вывода отчета.

Имя шаблона для этого репортера, указанного как вектор символов или скаляр строки. Шаблон для этого репортера должен находиться в библиотеке шаблонов источника шаблона (TemplateSrc) для этого репортера.

Цель гиперссылки для этого репортера, указанная как вектор символов или скаляр строки, указывающий идентификатор цели связи, или mlreportgen.dom.LinkTarget объект. Вектор символов или строковое скалярное значение преобразуется в LinkTarget объект. Цель ссылки непосредственно предшествует содержимому этого репортера в выходном отчете.

Методы

развернуть все

Примеры

свернуть все

Открыть сценарий в реальном времени

Сообщите выделенный синтаксисом код для функции myAdd.m.

Создание отчета.

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

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

Создание главы.

chap = Chapter("The myAdd Function");

Создать MATLABCode доклад о содержании myAdd.m.

mCode = MATLABCode("myAdd.m");

Добавьте репортера в главу и главу в отчет.

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

Закройте отчет и откройте средство просмотра.

close(rpt);
rptview(rpt);

Вот выделенный синтаксисом код в отчете.

См. также

| | |

Представлен в R2021a

Документация по генератору отчетов MATLAB

Поддержка