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 (2025). 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 릴리스 호환 정보
플랫폼 호환성
Windows macOS Linux카테고리
태그
도움
도움 받은 파일: exportToZip: Identifies the dependencies of an M-file and creates a ZIP file
도움 준 파일: Signal Simulation, Signal with noise
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!버전 | 게시됨 | 릴리스 정보 | |
---|---|---|---|
1.0.0.0 |