Updated 9 Nov 2011
% InsertHeader Adds a template to the top of current file in editor for documentation.
% InsertHeader('InsertHeader') added the current header information to this
% file. NOTE: THIS CANNOT BE UNDONE! THE FIRST TIME YOU USE THIS, PLEASE
% HAVE A BACK UP COPY OF THE FILE IN CASE IT MAKES A MISTAKE.
% Custom defined headers can be created in the subfunction defined at
% the end of the file. I wish to express thanks to the authors of tedit.m and
% newfcn.m which helped me to create this routine.
% See also: tedit, newfcn
The manner in which I use it is to define a shortcut with the command InsertHeader(). That way when I click the shortcut my header is automatically inserted into whichever file is on top.
Note: If you use keyword expansion with your source control software, it will replace the strings in your template, if you check this file in... so plan on correcting the text before you use it.
This function does perform calls to Java commands which are not part of the normal documentation.
Dan K (2023). InsertHeader (https://www.mathworks.com/matlabcentral/fileexchange/12323-insertheader), MATLAB Central File Exchange. Retrieved .
MATLAB Release Compatibility
Platform CompatibilityWindows macOS Linux
- MATLAB > Environment and Settings >
- MATLAB > Software Development Tools > Toolbox Distribution > Adding custom doc >
Inspired: Save a copy of current active *.m file in editor adding time mark.
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.