Documenting (help section of) an m-file

版本 1.0.0.0 (3.8 KB) 作者: Guzman
This script makes a template for documenting m-files.
505.0 次下载
更新时间 2013/4/22

查看许可证

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.

引用格式

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. 检索来源 .

MATLAB 版本兼容性
创建方式 R2010a
兼容任何版本
平台兼容性
Windows macOS Linux
类别
Help CenterMATLAB Answers 中查找有关 Adding custom doc 的更多信息

Community Treasure Hunt

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

Start Hunting!
版本 已发布 发行说明
1.0.0.0