Doxygen, эквивалентный для Mathematica?
Как Вы помещаете дополнительную информацию в файл пакета Mathematica, как
- спецификация параметра
- использование doctests/example?
До сих пор я только нашел:: строка использования и некоторая информация о том, как записать ноутбуки документации. Я ищу опцию генерировать эти ноутбуки документации из занимающихся самоанализом файлов пакета.
1 ответ
Я не знаю, есть ли какой-либо механизм, такой как доксиген, встроенный в математику.Если вы хотите встроить записную книжку для документации в свой пакет, я бы поступил следующим образом
- Запишите записную книжку для документации
- Встройте записную книжку в виде символьной строки в свой пакет
- Напишите справочную функцию, которая при вызове создаст файл, выпишет записную книжку и использует интерфейсные манипуляции для его открытия
Вы можете пропустить создание внешней записной книжки с помощью Notebook[] символьной строки для хранения записной книжки документации внутри файла пакета.
Интеграция с собственной справочной системой Mathematica немного сложнее (как объясняет приведенная вами ссылка). Конечно, вы все равно можете заставить пакет записать и переместить соответствующие файлы на место при загрузке пакета.