用于Mathematica的Doxygen等价物？

Question

你如何把额外的信息到一个数学包文件，像

• 参数规格
• 文档测试/例如使用？

到目前为止，我只找到关于如何编写文档笔记本的:: usage字符串和some information。我正在寻找一个选项来从introspecting包文件生成这些文档笔记本。

Answer 1

我不知道有什么机制，如doxygen内置到mathematica中。如果你要嵌入文档的笔记本电脑到你的包我将进行如下

1. 写了文档笔记本
2. 嵌入笔记本电脑在你的包的字符串
3. 写帮助功能，当所谓，包装箱一个文件，写出来的笔记本电脑，并使用前端操作来打开它

您可能能够通过使用Notebook[]而不是字符串来跳过外部笔记本的创建用于存储文档ñ otebook在你的包文件中。

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