适用于Mathematica的Doxygen?

如何将附加信息放入Mathematica包文件中,如

  • 参数说明
  • doctests /示例用法?
  • 到目前为止,我只找到:: usage字符串和一些关于如何编写文档笔记本的信息。 我正在寻找一个选项来从introspecting包文件生成这些文档笔记本。


    我不知道有什么机制,比如doxygen内置在mathematica中。 如果您想将文档笔记本嵌入到您的软件包中,我将按以下步骤操作

  • 编写文档笔记本
  • 将笔记本作为字符串嵌入到包中
  • 写一个帮助功能,当被调用时,创建一个文件,写出笔记本并使用前端操作来打开它
  • 您可能可以通过使用Notebook []而不是用于在文件包文件内存储文档笔记本的字符串来跳过创建外部笔记本。

    与Mathematica自己的帮助系统集成会更困难一些(正如您给出的链接所解释的那样)。 当然,您仍然可以编写软件包并在加载软件包时将适当的文件移动到适当位置。

    链接地址: http://www.djcxy.com/p/909.html

    上一篇: Doxygen equivalent for Mathematica?

    下一篇: How to minimize total cost of shortest path tree