mlreportgen.report.MATLABCode class

Пакет: mlreportgen.report

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

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

Описание

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

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

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

HandleCompatible
true

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

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

пример

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

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

Свойства

расширить все

Путь и имя файла, который содержит код MATLAB, заданный как вектор символов или строковый скаляр. Файл может иметь .m или .mlx расширение. Если вы задаете это свойство, MATLABCode reporter устанавливает 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отчет включает цикломатическую сложность McCabe каждой функции, содержащейся в коде MATLAB.

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

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

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

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

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

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

Методы

расширить все

Примеры

свернуть все

Открыть Live Script

Сообщите подсвеченный синтаксисом код для функции 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 Report Generator

Поддержка

Для просмотра документации необходимо авторизоваться на сайте