Publish markup and the help command
4 次查看(过去 30 天)
显示 更早的评论
What to have markup for Publishing and help text in the same .m file. When I try that the markup is not interpreted by help and the result looks horrible. And, Publish treats the help text as 'body text' and also looks bad. Is it possible to have both markup and help text in the same .m file and have the Published result look good and the help output also look good. Thanks, Roger
0 个评论
回答(1 个)
Praveen Reddy
2023-8-22
Hi Roger,
I understand that you could not organize the help text and text for markup in the same “.m” file. I suggest you to include help text below the function definition line and a separate section for markup.
function c = addme(a,b)
% ADDME Add two values together.
% C = ADDME(A) adds A to itself.
% C = ADDME(A,B) adds A and B together.
%
%%
% $x^2+e^{\pi i}$
% Block Equation
%
% $$e^{\pi i} + 1 = 0$$
%
switch nargin
case 2
c = a + b;
case 1
c = a + a;
otherwise
c = 0;
end
Please refer to the images attached for the output of “help” command and published “.m” file.
To know more about help text for functions, markup and publishing, please refer to the following MATLAB documentations.
另请参阅
类别
在 Help Center 和 File Exchange 中查找有关 Environment and Settings 的更多信息
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!