MATLAB头注释模板

想要规范化自己的代码编写，提高可读性，因此结合ChatGPT写了一个这样的模板，简易版本，可以根据自己的需求更改。

环境：WIN11, MATLAB2022b

下面是代码

function generateHeaderTemplate(filename, description)
% 生成 MATLAB 头注释模板

% 获取当前日期
dateStr = datestr(now, 'yyyy-mm-dd');

% 读取原始文件内容

content = fileread(filename);


% 创建头注释
header = sprintf('%%**************************************************************************\n');
header = [header, sprintf('%% 文件名: %s\n', filename)];
header = [header, sprintf('%% 版本: %s\n', "v1.0")];
header = [header, sprintf('%% 作者: %s\n', "fasdf")];
header = [header, sprintf('%% 联系方式: %s\n', "fasdf7")];
header = [header, sprintf('%% 日期: %s\n', dateStr)];
header = [header, sprintf('%% 描述: %s\n', description)];
header = [header, sprintf('%% 输入: %s\n', " ")];
header = [header, sprintf('%% 输出: %s\n', " ")];
header = [header, sprintf('%%**************************************************************************\n')];

% 将头注释和原始内容写入文件
fid = fopen(filename, 'w');
fprintf(fid, '%s\n', header);
fprintf(fid, '%s', content);
fclose(fid);

disp('头注释模板已生成。');
end

调用方法，本来想弄成快捷命令的，但是没有整好，后续再探索吧。

将下方语句直接粘贴到需要添加头注释的文件中执行一次即可。

% 添加头注释
filepath = mfilename('fullpath')
filepath = filepath+".m";
disp(filepath);
generateHeaderTemplate(filepath, "这是函数功能说明")

本地实验成功。