matlab:matlab_documentation_guidelines
MATLAB documentation guidelines
Make sure you have most recent copy of Igtools: https://github.com/igorkagan/Igtools (occasionally updated at Dropbox/DAG/Sources/Igtools)
1) After opening MATLAB
edit; EditorMacro('Alt-Control-h', @ig_createHeaderComment_dag);
Alternatively, add the above commands to startup.m.
2) PRESS Alt-Control-h while in MATLAB Editor (new or existing file)
This will add documentation template:
function ... = ...(...) %functionname - one line function description % % USAGE: % usage example1; % usage example2; % ... % % INPUTS: % input 1 - exlanation % ... % % OUTPUTS: % output1 - explanation % ... % % REQUIRES: ... % % See also ... % % % Author(s): ..., DAG, DPZ % URL: http://www.dpz.eu/dag % % Change log: % yyyymmdd: Created function (Author(s) firstname familyname) % ... % $Revision: 1.0 $ $Date: 2015-08-07 18:27:53 $ % ADDITIONAL INFO: % ... %%%%%%%%%%%%%%%%%%%%%%%%%[DAG mfile header version 1]%%%%%%%%%%%%%%%%%%%%%%%%%
Thanks to:
Yair M. Altman
http://undocumentedmatlab.com/blog/editormacro-assign-a-keyboard-macro-in-the-matlab-editor
matlab/matlab_documentation_guidelines.txt · Last modified: 2022/12/29 07:15 by 127.0.0.1