How to access subfunction headers with "help" command?
1 vue (au cours des 30 derniers jours)
Afficher commentaires plus anciens
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
0 commentaires
Réponse acceptée
Adam
le 14 Nov 2014
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 commentaires
Image Analyst
le 10 Jan 2015
I guess you'd need to make it a comment for it to appear, just like the other comments appear:
% function foo = mySubFunc(bar)
Plus de réponses (1)
per isakson
le 10 Jan 2015
Modifié(e) : per isakson
le 12 Jan 2015
"Something like help myFunc.mySubFunc?"   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
0 commentaires
Voir également
Catégories
En savoir plus sur Scope Variables and Generate Names dans Help Center et File Exchange
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!