Equivalente Doxygen per Mathematica?

Question

Come si fa a mettere ulteriori informazioni in un file del pacchetto Mathematica, come

• specifica del parametro
• doctests/esempio di utilizzo?

Fino ad ora, ho trovato solo la stringa :: usage e some information su come scrivere quaderni di documentazione. Sto cercando un'opzione per generare questi taccuini di documentazione dall'introspezione dei file del pacchetto.

Answer 1

Non so che ci sia un meccanismo come doxygen incorporato in matematica. Se si desidera incorporare un quaderno di documentazione nel pacchetto vorrei procedere come segue

1. Scrivi il notebook documentazione
2. incorporare il notebook come una stringa di caratteri nel pacchetto
3. Scrivete una funzione di aiuto che, quando chiamato, casse di un file, scrive il notebook e utilizza le manipolazioni di front-end per aprirlo

potreste essere in grado di saltare la creazione del notebook esterno utilizzando Notebook[] al posto di una stringa di caratteri per la memorizzazione della documentazione n otebook all'interno del file del pacchetto.

L'integrazione con il sistema di guida di Mathematica è un po 'più difficile (come spiega il collegamento che hai fornito). Naturalmente, si può ancora scrivere il pacchetto e spostare i file appropriati in posizione quando il pacchetto viene caricato.