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
%
Cite As
Jan (2024). MATLAB help generator (https://www.mathworks.com/matlabcentral/fileexchange/47843-matlab-help-generator), MATLAB Central File Exchange. Retrieved .
MATLAB Release Compatibility
Platform Compatibility
Windows macOS LinuxTags
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!Discover Live Editor
Create scripts with code, output, and formatted text in a single executable document.