MATLAB: nápověda k vlastním funkcím a vygenerování help reportu

Formátování nápovědy:

function foo(x,y,z)
%FOO One-line description goes here
%
% foo(x,y,z)
%
% Multi-line paragraphs of descriptive text go here. It's fine for them to
% span lines. It's treated as preformatted text; help() and doc() will not
% re-wrap lines. In the editor, you can highlight paragraphs, right-click,
% and choose "Wrap selected comments" to re-flow the text.
%
% More detailed help is in the <a href="matlab: help foo>extended_help">extended help</a>.
% It's broken out like this so you can keep the main "help foo" text on 
% a single screen, and then break out obscure parts to separate sections.
%
% Examples:
% foo(1,2,3)
%
% See also:
% BAR
% SOMECLASS/SOMEMETHOD

disp(x+y+z);

function extended_help
%EXTENDED_HELP Some additional technical details and examples
%
% Here is where you would put additional examples, technical discussions,
% documentation on obscure features and options, and so on.

error('This is a placeholder function just for helptext');

Reference https://stackoverflow.com/questions/3840657/matlab-m-file-help-formatting.

Automatické vygenerování struktury

Pro automatické vytvoření struktury nápovědy jen z názvu funkce doporučuji

http://jankoweb.wz.cz/blog/odborny-sw/matlab-generator-napovedy-pro-funkce/.

Vygenerování help reportu

Když v okně Current Folder označíte více funkcí, můžete si k nim nechat z Vašich nápověd vygenerovat zprávu.

Generování helpu
Generování helpu
Okno správy helpu
Okno správy helpu
Rubrika Odborný SW | Tagy MATLAB, Formát, Help, Komentář | Čt 29.06.2017 | 512x

Náhodné články

© 2008-201919 JK, kontakt, právní upozornění
Powered by Janko's RS| XHTML, CSS, RSS, analýza kódu, SEO servis, dostupnost, hosting, líbí se Vám tu?
Požadavek: 0.96405 s, generování: 0.07085 s, paměť: 1.49 MB, sql dotazů: 7, CPU: 15.33

.