MATLAB help generator
Copy source of the script to your MATLAB shortcut - e.g. with name Generate Help. Then open your m-file with function and select first line (function declaration with inputs, outputs). Then click on your Generate Help shortcut.
One line bellow first function line will be generated text with template of description.
Example:
========
Selected text:
--------------
function [] = downloadData(name_of_instance)
Created text:
-------------
function [] = downloadData(name_of_instance)
% function [] = downloadData(name_of_instance)
% Function .
%
% INPUT
% name_of_instance [string] ...
%
% OUTPUT
% [] ...
%
% Author: John Smith (john@mail.com)
% Version: 1.0, 20140905
% Changelog:
% 1.0 - first implementation
%
Citation pour cette source
Jan (2024). MATLAB help generator (https://www.mathworks.com/matlabcentral/fileexchange/47843-matlab-help-generator), MATLAB Central File Exchange. Récupéré le .
Compatibilité avec les versions de MATLAB
Plateformes compatibles
Windows macOS LinuxTags
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!Découvrir Live Editor
Créez des scripts avec du code, des résultats et du texte formaté dans un même document exécutable.
Version | Publié le | Notes de version | |
---|---|---|---|
1.2.0.0 | bug fix in output params (they wasn't parsed) |
||
1.1.0.0 | edited description |
||
1.0.0.0 |