Adding help content to AppDesigner App

2017 9 29
3 个回答
更新时间：2020 9 18
13 次查看（30 天）

0 个投票

Does anybody know how to add comments to an .MLAPP such that "help myapp" returns the help content? Currently, all I get is "myapp is a class. [hyperlink]Reference page for myapp" The reference page is awesome, but my users like the standard help display.

请先登录，再回答此问题。

回答（3 个）

Greg
Greg 2017-10-10
编辑：Greg 2017-10-10

1 个投票

According to Function Precedence, .mlapp files are above .m files. This means we can create an .m file with the same name as our App, and put the help content in that .m file.
The caveat is at the command window:
help MyApp
returns the not-so-helpful "MyApp is a class." However,
help MyApp.m
forces MATLAB to look at the .m file rather than the .mlapp, and displays the help desired. This shouldn't have any run-time side effects, and only puts a small burden on users to explicitly add the ".m" to the help command input.
Ramanuja Jagannathan
编辑：Ramanuja Jagannathan 2017-10-5

0 个投票

I don't think the feature is currently available. The guess the reference page option (doc link below)available as of now.
https://www.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html
Nicholas Ayres
Nicholas Ayres 2020-9-18

0 个投票

From what I can tell, no.
Greg's workaround is one suggestion. Alternatively, I've decided to write a static help function in my class which basically just contains an fprintf statement of what I want my help file to say.
At least then you can access it via myApp.help

类别

在 帮助中心 和 File Exchange 中查找有关 Startup and Shutdown 的更多信息

标签

提问:

Greg
Greg
2017-9-29

回答：

Nicholas Ayres
Nicholas Ayres
2020-9-18

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Translated by