Доксигенный эквивалент для Mathematica?

Question

Как засунуть дополнительную информацию в файл пакета Mathematica, как

• спецификации параметра
• doctests/пример использования?

До сих пор я нашел строку использования :: some information о том, как писать тетради документации. Я ищу возможность генерировать эти блокноты документации для интроспекции файлов пакетов.

Answer 1

Я не знаю, что есть какой-либо механизм, такой как doxygen, встроенный в математику. Если вы хотите, чтобы встроить документацию ноутбук в свой пакет, я бы действовать следующим образом

1. подправить документации ноутбук
2. Вставить ноутбук в виде строки символов в вашем пакете
3. Написать функцию справки, которая, когда называется, ящики файла, выписывает ноутбук и использует передок манипуляции, чтобы открыть его

Вы можете быть в состоянии пропустить создание внешнего ноутбука с помощью Notebook[] вместо строки символов для хранения документации п otebook внутри вашего файла пакета.

Интеграция с собственной справочной системой Mathematica немного сложнее (как поясняет ссылка). Конечно, вы все равно можете записать пакет и переместить соответствующие файлы на место при загрузке пакета.