How to generate the custom help box for a custom function (More Help...)

Question

breathi 2019-12-9

1
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/495677-how-to-generate-the-custom-help-box-for-a-custom-function-more-help

回答： Andrii Zelenko 2021-7-10

Hi everyone,

I recently dealt with proper help for my custom functions.

I found out that there are 4 points one can handle:

doc myfun: Will show file help or if available the html help (https://de.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html)
writing your function, then typing in the opening bracket and waiting. A small box will appear showing input parameters
help myfun: Will display the comments at the top of the function (https://de.mathworks.com/help/matlab/matlab_prog/add-help-for-your-program.html)
tab completion with functionSignatures.json (https://de.mathworks.com/help/matlab/matlab_prog/customize-code-suggestions-and-completions.html and also https://undocumentedmatlab.com/articles/user-defined-tab-completions-take-2)

For 2.: Where can I find how to do this? For custom functions, only the input parameters are shown. But for Matlab Built-Ins, all available syntaxes are shown. They sometimes even differ from the "syntax" part in the html help, see movmean function help and the "bracket opening"-help for the info on datetime object, see picture below.

Are there even other "standard" help functionalities besides the four above?

Thanks for some advice.

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

请先登录，再进行评论。

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

Answer 1

Sahithi Kanumarlapudi 2019-12-18

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/495677-how-to-generate-the-custom-help-box-for-a-custom-function-more-help#answer_406907

You can refer to a similar question here

1 个评论
显示 -1更早的评论隐藏 -1更早的评论

breathi 2019-12-18

编辑：breathi 2019-12-18

Hi there,

this question you linked does not seem to be answered at all. From what I understood, this refers to point 4 I mentioned and is only referring to live scripts, not the command window? See Jan's comment.

请先登录，再进行评论。