equivalente de Doxygen para Mathematica?

Question

¿Cómo se pone la información adicional en un archivo de paquete de Mathematica, como

• la especificación de parámetros
• prueba unitaria/Uso ejemplo?

Hasta ahora, solo he encontrado la cadena :: usage y some information sobre cómo escribir cuadernos de documentación. Estoy buscando una opción para generar estos cuadernos de documentación a partir de la introspección de los archivos del paquete.

Answer 1

No sé si hay algún mecanismo como doxygen incorporado en mathematica. Si desea incrustar un cuaderno documentación en su paquete procedería de la siguiente manera

1. redactar el cuaderno documentación
2. Insertar el portátil como una cadena de caracteres en el paquete
3. escribir una función de ayuda que, cuando llamada, baúles un archivo, escribe el portátil y utiliza las manipulaciones de extremo frontal para abrirlo

Usted puede ser capaz de saltar la creación de la portátil externa usando Notebook[] en lugar de una cadena de caracteres para almacenar la documentación n otebook dentro de su archivo de paquete.

La integración con el sistema de Ayuda de Mathematica es un poco más difícil (como explica el enlace que proporcionó). Por supuesto, aún podría hacer que el paquete escriba y mover los archivos apropiados a su lugar cuando se cargue el paquete.