Расширенные файлы документации XML

Каждый блок MATLAB® Compiler SDK™.NET включает файл readme.txt в директории src и distrib. Этот файл обрисовывает в общих чертах содержимое автоматически сгенерированных шаблонов документации, включенных с вашим созданным компонентом. Шаблоны документации являются HTML и XML-файлами, которые могут быть считаны и обработаны любым количеством сторонних программ.

  • MWArray.xml — Этот файл описывает классы преобразования данных MWArray и их связанные методы. Документация для классов MWArray и их методы доступны здесь.

  • component_name.xml — Этот файл содержит комментарии к коду для вашего компонента. Используя сторонний инструмент документации, можно объединить этот файл с MWArray.xml, чтобы произвести файл подробной документации, который может быть группирован с блоком компонента для распределения конечным пользователям.

  • component_name_overview.html — Опционально включайте этот файл в сгенерированный файл документации. Это содержит обзор шагов, должен был получить доступ к компоненту и как использовать классы преобразования данных, содержавшиеся в иерархии классов MWArray, чтобы передать аргументы сгенерированному компоненту и возвратить результаты.