Create help text for subfunctions

Question

Morten Lindhardt Madsen 2012-5-4

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/37394-create-help-text-for-subfunctions

Hi

I have a script with a main function and some subfunctions under it (all in same script). I need to write help text for the subfunctions, so that the user can write help (the name of the subfunction) and then my help text will appear. Any ideas?

- Morten

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

Daniel Shub 2012-5-4

You have a script with a functions in it? I am pretty sure that is not supported. Assuming you have an m file with a function called myfunc and a subfunction called mysubfunc, then my subfunc cannot be called by the user so giving a help sections doesn't seem to make sense. Additionally, this could cause problems for searching for overloaded functions.

请先登录，再进行评论。

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

Answer 1

Morten Lindhardt Madsen 2012-5-4

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/37394-create-help-text-for-subfunctions#answer_46718

Well i just found out how to do it:

help functionname>subfunctionname

It works perfectly. And it is very usefull when you get an error from one of the subfunctions. Then you can call the help text that tells you what the function does. It provides faster overview of troubleshooting.

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

请先登录，再进行评论。

Answer 2

Jan 2012-5-4

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/37394-create-help-text-for-subfunctions#answer_46695

The help command looks for the help section of the main function only. Therefore you cannot define helpsections for the subfunctions, which can be found by help SubFunctionName.

As Daniel has explained already, this would not be useful at all, because the subfunction cannot be reached externally.