代码之家  ›  专栏  ›  技术社区  ›  Karsten W.

对mathematica来说是doxygen等价物?

  •  7
  • Karsten W.  · 技术社区  · 15 年前

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

    • 参数说明
    • 博士学位/示例用法?

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

    1 回复  |  直到 15 年前
        1
  •  3
  •   Timo    15 年前

    我不知道Mathematica中有任何机制,比如doxygen。如果你想在你的包中嵌入一个文档笔记本,我会按如下步骤进行

    1. 写文档笔记本
    2. 将笔记本作为字符串嵌入包中
    3. 编写一个帮助函数,当被调用时,将文件打包,写出笔记本,并使用前端操作打开它

    通过使用 Notebook[] 而不是将文档笔记本存储在包文件中的字符串。

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