Mathematica的等效氧气？

Question

如何将其他信息添加到Mathematica包文件中,例如

• 参数规范
• doctests/example用法？

到目前为止,我只找到了:: usage字符串以及有关如何编写文档笔记本的一些信息.我正在寻找从内省包文件生成这些文档笔记本的选项.

Answer 1

我不知道mathematica中内置了doxygen等任何机制。如果您想将文档笔记本嵌入到您的包中，我将按以下步骤操作

1. 编写文档笔记本
2. 将笔记本作为字符串嵌入到包中
3. 编写一个帮助函数，在调用时创建一个文件，写出笔记本并使用前端操作将其打开

您可以使用Notebook[]而不是字符串来跳过外部笔记本的创建，以将文档笔记本存储在包文件中。

与 Mathematica 自己的帮助系统集成有点困难（正如您提供的链接所解释的那样）。当然，您仍然可以在包加载时写入包并将适当的文件移动到位。