slreportgen.report.DocBlock.customizeReporter

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

Создайте пользовательский класс DocBlock reporter

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

Синтаксис

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

Описание

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

Входные параметры

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

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

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

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

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

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

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

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

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

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

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

Примеры

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

Создайте пользовательского 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 Report Generator

Поддержка

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