documentation-generation - Mathematica 的 Doxygen 等价物？

Question

您如何将附加信息放入 Mathematica 包文件中，例如

参数说明

文档测试/示例用法？

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

Answer 1

我不知道mathematica中是否有任何机制，例如doxygen。如果您想将文档笔记本嵌入到您的包中，我将按照以下步骤进行

写下文档笔记本

将笔记本作为字符串嵌入到您的包中

编写一个帮助函数，当调用它时，创建一个文件，写出笔记本并使用前端操作打开它

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

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