mlreportgen.report.MATLABCode class

Пакет: 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 генератор отчетов используется, чтобы сообщить и отформатировать табличные данные сложности кода. Значением по умолчанию этого свойства является BaseTableобъект с TableStyleName набор свойств к "MATLABCodeTable" и другой набор свойств к значениям по умолчанию. Можно настроить внешний вид таблицы путем настройки генератора отчетов по умолчанию или заменив его на пользовательский BaseTable генератор отчетов. Любое содержимое, которое вы задаете в Title свойство значения по умолчанию или замены BaseTable генератор отчетов появляется перед заголовком в сгенерированном отчете.

Атрибуты:

GetAccess
public
SetAccess
public

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open 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

Поддержка

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