如何在 Matlab 中向 类 添加全面的帮助页面
How to add comprehensive help pages to classes in Matlab
我正在 Matlab 中开发一个面向对象的应用程序,想知道如何添加像 Matlab 自己的函数这样的综合帮助页面,类 确实有。我对将 Latex 添加到帮助页面特别感兴趣。作为示例,我添加了一张图片,说明我的帮助页面的外观以及我希望它们看起来像什么。
因此,在阅读了更多 Matlab 帮助页面之后,似乎有一种方法可以获得漂亮且可搜索的文档:
- 将帮助作为 marked up 评论添加到 class 文件顶部。
- 发布这些文件和 turn off the options "Evaluate code", "Catch error" 如果你不想显示你的代码和帮助页面的末尾也关闭 "Include code".
- 您的申请完成后,package it。
- 将所有已发布的 html 文件移动到一个文件夹中,例如 "html" 或 "doc"。
- 将 required xml files 添加到您的 html 目录。
- 可选择添加 examples.
- 使用 builddocsearchdb 使您的服装帮助可从内置的 Matlab 帮助浏览器中搜索。
我正在 Matlab 中开发一个面向对象的应用程序,想知道如何添加像 Matlab 自己的函数这样的综合帮助页面,类 确实有。我对将 Latex 添加到帮助页面特别感兴趣。作为示例,我添加了一张图片,说明我的帮助页面的外观以及我希望它们看起来像什么。
因此,在阅读了更多 Matlab 帮助页面之后,似乎有一种方法可以获得漂亮且可搜索的文档:
- 将帮助作为 marked up 评论添加到 class 文件顶部。
- 发布这些文件和 turn off the options "Evaluate code", "Catch error" 如果你不想显示你的代码和帮助页面的末尾也关闭 "Include code".
- 您的申请完成后,package it。
- 将所有已发布的 html 文件移动到一个文件夹中,例如 "html" 或 "doc"。
- 将 required xml files 添加到您的 html 目录。
- 可选择添加 examples.
- 使用 builddocsearchdb 使您的服装帮助可从内置的 Matlab 帮助浏览器中搜索。