Exponenta 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/template подпапка папки, которая содержит файл определения класса. Можно использовать файл определения класса в качестве начальной точки, чтобы спроектировать пользовательский класс генератора отчетов DocBlock для отчета.

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

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

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

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

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

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

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

Чтобы создать класс генератора отчетов в пакете класса, предшествуйте имени папки с + символ. Например, этот код создает генератор отчетов 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 Report Generator
Поддержка