用於Mathematica的Doxygen等價物？

Question

你如何把額外的信息到一個數學包文件，像

• 參數規格
• 文檔測試/例如使用？

到目前爲止，我只找到關於如何編寫文檔筆記本的:: usage字符串和some information。我正在尋找一個選項來從introspecting包文件生成這些文檔筆記本。

Answer 1

我不知道有什麼機制，如doxygen內置到mathematica中。如果你要嵌入文檔的筆記本電腦到你的包我將進行如下

1. 寫了文檔筆記本
2. 嵌入筆記本電腦在你的包的字符串
3. 寫幫助功能，當所謂，包裝箱一個文件，寫出來的筆記本電腦，並使用前端操作來打開它

您可能能夠通過使用Notebook[]而不是字符串來跳過外部筆記本的創建用於存儲文檔ñ otebook在你的包文件中。

與Mathematica自己的幫助系統集成有點困難（正如您給出的鏈接所解釋的）。當然，您仍然可以編寫軟件包並在加載軟件包時將適當的文件移動到適當位置。