Documenting (help section of) an m-file

Version 1.0.0.0 (3,84 KB) von Guzman
This script makes a template for documenting m-files.
505 Downloads
Aktualisiert 22. Apr 2013

Lizenz anzeigen

This piece of code writes a template for documenting m-files. It writes the template just after the function definition header. It finds out which are the input and output arguments (if any) and writes them down in the documentation/help section.
The script also uses Malcolm Wood's subission at
http://www.mathworks.com/matlabcentral/fileexchange/10702-exporttozip-identifies-the-dependencies-of-an-m-file-and-creates-a-zip-file
to find the dependencies of the script and annotate them into the the help section.
For instance, by introducing:
>> DocFun('DocFun', 'Guzmán Díaz')
it documents 'DocFun.m' proper.
That is, it finds the input and output arguments, the dependencies, the date, Matlab version, and leaves the rest to be completed by the author.
Because things might go terribly wrong, the script makes a copy (with extension .bak) of the original file before proceeding; which must be manually deleted if results are satisfactory.

Zitieren als

Guzman (2024). Documenting (help section of) an m-file (https://www.mathworks.com/matlabcentral/fileexchange/41423-documenting-help-section-of-an-m-file), MATLAB Central File Exchange. Abgerufen.

Kompatibilität der MATLAB-Version
Erstellt mit R2010a
Kompatibel mit allen Versionen
Plattform-Kompatibilität
Windows macOS Linux
Kategorien
Mehr zu Adding custom doc finden Sie in Help Center und MATLAB Answers

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!
Version Veröffentlicht Versionshinweise
1.0.0.0