Create help for method with arguments

10 次查看（过去 30 天）
Vasco
Vasco 2022-3-21
编辑： Matt J 2022-3-21
I like to document my functions, such that on pressing on F1, it shows description of the function, and its parameters.
The recently introduced arguments block allows to define arguments sizes and types. What is the best practice to document these arguments?
I preferably like to keep the defintion and the documentation at the same location, like in the example below:
function [m,s] = twoStats(x)
% Test for help
arguments
x (1,:) {mustBeNumeric} % Argument 1, the array to calculate statistics on
end
m = mean(x,"all");
s = std(x,1,"all");
end
Preferred output:
doc twoStats
Test for help
Arguments:
- x: Argument 1, the array to calculate statistics on

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

回答（1 个）

Matt J
Matt J 2022-3-21
function [m,s] = twoStats(x)
% Test for help
%
%Arguments:
% - x: Argument 1, the array to calculate statistics on
arguments
x (1,:) {mustBeNumeric} % Argument 1, the array to calculate statistics on
end
m = mean(x,"all");
s = std(x,1,"all");
end
  2 个评论
Vasco
Vasco 2022-3-21
Ok, this seems the trivial solution, just copy paste the information from the arguments block to the documentation block. However, now the documentation and definition is split to different places.
Matt J
Matt J 2022-3-21
编辑：Matt J 2022-3-21
There is no other solution. The help text can only be in one place. You could of course, write tools that will semi-automate the documentation process. Once you have the argument text copied to the clipboard, code like the following can be used to parse it into the format you want:
>> contents = clipboard('paste')
contents =
'x (1,:) {mustBeNumeric} % Argument 1, the array to calculate statistics on'
>> out = "% - "+extractBefore(contents,' ')+" "+extractAfter(contents,'%'); disp(out)
% - x Argument 1, the array to calculate statistics on

请先登录，再进行评论。

类别

在 Help Center 和 File Exchange 中查找有关 Testing Frameworks 的更多信息

标签

产品

Community Treasure Hunt

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

Start Hunting!

Translated by