Create help for method with arguments
2 visualizzazioni (ultimi 30 giorni)
Mostra commenti meno recenti
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
0 Commenti
Risposte (1)
Matt J
il 21 Mar 2022
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 Commenti
Matt J
il 21 Mar 2022
Modificato: Matt J
il 21 Mar 2022
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
Vedere anche
Categorie
Scopri di più su Logical in Help Center e File Exchange
Prodotti
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!