How to access subfunction headers with "help" command?

1 次查看（过去 30 天）
Marshall
Marshall 2014-11-14
编辑： per isakson 2015-1-12
Hallo userbase,
for the following situation, is it possible to print the subfunction header to the command window using help?
function foo = myFunc(bar)
%MYFUNC
% A pointless function to demonstrate my question.
% @param <bar> input var
% @return <foo> output var
foo = mySubFunc(bar);
end % END myFunc
function foo = mySubFunc(bar)
%MYFUNC.MYSUBFUNC
% Here is some information about my very important and refactored subfunction.
foo = bar + bar;
end % END mySubFunc
If I punch in help myFunc :
>> help myFunc
myFunc
A pointless function to demonstrate my question.
@param <bar> input var
@return <foo> output var
But is there some way to access the subfunction header? Something like help myFunc.mySubFunc?
All the best, Marshall

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

采纳的回答

Adam
Adam 2014-11-14
I'm fairly sure you can't. The subfunction is private to the file it is in so it has no outside visibility and shouldn't need it either since it cannot be called from outside of its parent file.
  2 个评论
Marshall
Marshall 2014-11-25
Huh, that's weird. Thanks for the reply!
I really thought I read something somewhere, or had done something. Must have been dreaming in code again...
Image Analyst
Image Analyst 2015-1-10
I guess you'd need to make it a comment for it to appear, just like the other comments appear:
% function foo = mySubFunc(bar)

请先登录，再进行评论。

更多回答（1 个）

per isakson
per isakson 2015-1-10
编辑：per isakson 2015-1-12
"Something like help myFunc.mySubFunc?" &nbsp Yes, it's possible with R2013a (and earlier). Try
>> help cssm>sub_cssm
sub_cssm - subfunction of cssm
where
function cssm
end
function sub_cssm
% sub_cssm - subfunction of cssm
end

类别

在 Help Center 和 File Exchange 中查找有关 Scope Variables and Generate Names 的更多信息

标签

Community Treasure Hunt

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

Start Hunting!

Translated by