"Analyzování druhých je ve skutečnosti vyjádřením našich vlastních potřeb a hodnot."

M. Rosenberg

Matlab: generátor nápovědy pro funkce

Stačí vybrat řádek s definicí funkce a spustit níže uvedený kód (ideální udělat si z něj zkratku). Automaticky se připraví šablona na dopsání nápovědy k funkci (vypíší se parametry, popis...):

% matlab help generator - select line with function definition.
% e.g.: function [times, data, var_names, info] = Import(file_path)

author = 'Moje Jmeno (muj@mail.cz)';

editor = matlab.desktop.editor.getActive;
sel = editor.SelectedText;
% parse function
if (strfind(sel,'function')~=1)
    error('No function selected.')
else
    io1 = strfind(sel,'[');
    io2 = strfind(sel,']');
    ii1 = strfind(sel,'(');
    ii2 = strfind(sel,')');
    % parse parameters
    outputs = sel(io1+1:io2-1);
    outputs = strsplit(outputs,' ');
    
    inputs = sel(ii1+1:ii2-1);
    inputs = strrep(inputs,' ','');
    inputs = strsplit(inputs, ',');

    % create text help
    str = sprintf('\n%% %s',sel);
    str = sprintf('%s\n%% Function .\n',str);
    str = sprintf('%s%%\n%% INPUT\n', str);    
    for param=inputs
       str = sprintf('%s%%  %s [] ... \n', str, char(param));    
    end
    str = sprintf('%s%%\n%% OUTPUT\n', str);    
    for param=outputs
       str = sprintf('%s%%  %s [] ... \n', str, char(param));    
    end
    str = sprintf('%s%%\n', str);    
    str = sprintf('%s%% Author: %s\n', str, author);    
    str = sprintf('%s%% Version: 1.0, %s\n', str, datestr(now,'yyyymmdd'));    
    str = sprintf('%s%% Changelog: \n%%  1.0 - first implementation\n%%\n', str);    
end
editor.insertTextAtPositionInLine(str,editor.Selection(3),editor.Selection(4));

Kód na Mathworku: http://www.mathworks.com/matlabcentral/fileexchange/47843-matlab-help-generator.

Rubrika Odborný SW | Tagy Matlab, Help | Čt 31.10.2013 | 1311x

Související články:

MATLAB: úprava popisku osy x (vydáno Po 13.03.2017, 12:16)
MATLAB: dávková úprava figure (vydáno Po 13.03.2017, 12:12)
MATLAB: divné chování keeplimits u dateaxis (vydáno Po 20.02.2017, 11:52)
MATLAB: otevření složky z MATLABu (vydáno Ne 05.07.2015, 10:23)
MATLAB: error attempt to add "" to a static workspace (vydáno Pá 03.07.2015, 10:23)
MATLAB: spuštění m-file na Linuxu přímo v MATLABu (vydáno So 27.06.2015, 10:23)
MATLAB help generator - File Exchange - MATLAB Central (vydáno Čt 11.06.2015, 10:23)
Matlab: zjištění závislostí a toolboxů dané funkce (vydáno Ne 26.10.2014, 16:13)
Matlab java.lang.OutOfMemoryError  (vydáno So 14.06.2014, 11:31)
Matlab: na Linuxu nejde změnit velikost fontu (vydáno Pá 27.12.2013, 18:55)
Matlab: generátor nápovědy pro funkce (vydáno Čt 31.10.2013, 16:51) - právě čtete
Matlab: tipy a triky pro práci se strukturami (vydáno Út 13.08.2013, 13:53)
Matlab: práce s error, warning a try catch (vydáno Po 05.08.2013, 13:48)
Matlab: prohlížeč obrázků (vydáno Čt 01.08.2013, 22:23)
Matlab: skrytí warning (vydáno Čt 18.07.2013, 14:59)
MATLAB: vícenásobná substituce proměnné v matici (vydáno Út 12.03.2013, 12:46)
Matlab a LaTeX: rychlý export matice do LaTeXu (vydáno St 24.10.2012, 10:12)
Matlab: praktické tipy pro práci s figurami (grafy) (vydáno St 14.12.2011, 10:30)
Matlab: praktické rady pro ladění kódu aneb Debug mode (vydáno Ne 11.12.2011, 19:24)
Matlab: zkratky pro často se opakující příkazy přímo v toolbaru (vydáno Ne 20.11.2011, 18:32)
Matlab: převod výrazu do formátu LaTeXu (vydáno Út 17.05.2011, 23:12)
Matlab: Vigenerova šifra (vydáno Pá 15.04.2011, 10:44)
Matlab: instalace na Linuxu UBUNTU (vydáno Pá 25.02.2011, 18:03)
Matlab: úpravy výrazů (vydáno St 23.02.2011, 18:03)
Matlab: export grafu do pdf (vydáno So 05.02.2011, 23:58)
Matlab: TODO, FIXME a cell mode (vydáno Pá 10.12.2010, 17:36)
Matlab: defaultní nastavení grafu (vydáno Út 16.11.2010, 12:31)
Matlab: přehled exportů grafického výstupu (vydáno Pá 09.07.2010, 16:37)
Matlab - funkce pro textový výstup (vydáno So 13.03.2010, 19:39)
Matlab - práce s řetězci (vydáno Čt 22.10.2009, 17:03)

Náhodné články

.