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

Question

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

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

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

Answer 1

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

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

Возможно, вы сможете пропустить создание внешней записной книжки, используя Записная книжка [] вместо строки символов для хранения записной книжки с документами в файле пакета.

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