How do you write comments in sub functions?

Question

Bryan 2017-11-22

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/368530-how-do-you-write-comments-in-sub-functions

评论： Stephen23 2017-11-22

So I'm given a homework problem in my Introductory Matlab class, where I'm suppose to write my own function about a rocket. My function has two sub functions called gravity and thrust. So my professor requires us to write comments describing our function, using the % command. I'm having trouble figuring out where to write the commends for p2 and p3. p4 I wrote that under the sub function gravity, and for p5 under the sub function for thrust. But when I try to write a comment for p2 or p3, it runs this in the command window:

'gravity not found.' or 'thrust not found' .

I wrote these comments in the sub functions and the general function, but I keep getting this same answer. Does anyone know where would I write the %comments for p2 and p3. (function runs perfectly) Thanks.

p2 = evalc('help gravity');
p3 = evalc('help thrust');
p4 = evalc('help rocket>gravity');
p5 = evalc('help rocket>thrust');

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

Stephen23 2017-11-22

Why are you using evalc for this? Why not just call help directly?

请先登录，再进行评论。

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

Answer 1

Guillaume 2017-11-22

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/368530-how-do-you-write-comments-in-sub-functions#answer_292520

在 MATLAB Online 中打开

It's not exactly clear what you are calling subfunctions. I'm going to assume that you mean either a local, nested or private function.

It's also not clear what problem you are having. Comments can be written (nearly) anywhere you want. Inside or outside any function. They're just ignored by matlab. However, looking at your evalc lines, it looks like you're trying to access the help for the functions you've written.

Help is indeed written as comments and must immediately follow the function declaration, regardless the type of function.

e.g., in file rocket.m:

function something = rocket(somethingelse)    
    %rocket: guide the rocket to mars
    %this is a normal function
end
function x = gravity(y)
   %gravity: apply the effect of gravity onto the rocket
   %this is a local function in the same file as rocket
end

at the command prompt:

>>help rocket
 rocket: guide the rocket to mars
 this is a normal function
>>help rocket>gravity
 gravity: apply the effect of gravity onto the rocket
 this is a local function in the same file as rocket