Exponenta Banner
exponenta event banner

slreportgen.report. DocBlock.customizeReporter

Класс: slreportgen.report.DocBlock
Пакет: slreportgen.report

Создание пользовательского класса репортеров DocBlock

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

Синтаксис

reporter = slreportgen.report.DocBlock.customizeReporter(classpath)

Описание

reporter = slreportgen.report.DocBlock.customizeReporter(classpath) создает файл определения класса, определяющий подкласс slreportgen.report.DocBlock в местоположении, указанном classpath. Метод также копирует шаблоны отчетов по умолчанию в resources/templates подпапка папки, содержащая файл определения класса. Файл определения класса можно использовать в качестве отправной точки для создания пользовательского класса репортеров DocBlock для отчета.

Входные аргументы

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

Путь и имя нового файла определения класса, заданного как строковый скалярный или символьный вектор.

Можно указать относительный или абсолютный путь. Например, этот код создает MyClass.m во вложенной папке myFolder текущей папки.

slreportgen.report.DocBlock.customizeReporter("myFolder/MyClass")

Чтобы создать класс reporter в папке класса, перед именем класса введите @ персонаж. Не указывайте .m расширение. Например, этот код создает MyClass.m во вложенной папке myFolder/@MyClass в текущей папке.

slreportgen.report.DocBlock.customizeReporter("myFolder/@MyClass")
См. раздел Папки, содержащие определения классов.

Чтобы создать класс репортера в пакете классов, перед именем папки введите + персонаж. Например, этот код создает репортер DocBlock в myOrg папка пакета в текущей папке.

slreportgen.report.DocBlock.customizeReporter("+myOrg/@DocBlock");

Выходные аргументы

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

Путь и имя файла нового класса репортеров DocBlock, возвращаемого в виде строкового скаляра.

Примеры

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

Создайте пользовательский репортер DocBlock, MyDocBlockи связанные с ним шаблоны по умолчанию во вложенной папке MyFolder текущей рабочей папки. 

slreportgen.report.DocBlock.customizeReporter('MyFolder/MyDocBlock')

ans = 

    "MyFolder\MyDocBlock.m"

После редактирования нового файла класса его можно использовать в качестве репортера DocBlock.

rptr = MyDocBlock();

Создайте пользовательский репортер DocBlock и связанные с ним шаблоны по умолчанию в папке класса, которая является подпапкой папки пакета.

slreportgen.report.DocBlock.customizeReporter("+MyPackage/@MyDocBlock")

ans = 

    "+MyPackage\@MyDocBlock\MyDocBlock.m"

После редактирования нового файла класса его можно использовать в качестве репортера DocBlock.

rptr = MyPackage.MyDocBlock();

См. также

|

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

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

Поддержка