用途:为 MATLAB 函数、类或脚本文件生成或改进符合 MathWorks 标准的帮助注释,也可评审现有帮助文本的合规性。适用于新写帮助、补全或改写不合规帮助、为 classdef 方法添加帮助、生成类属性注释等;不适用于通用文档或 README、非 MATLAB 语言、MATLAB Live Script 标记,也不生成代码。
主要能力与标准要点:帮助文本须遵守强制规则,包括位置(函数/类从第 2 行开始,脚本从第 1 行开始)、缩进须与正文一致、不使用制表符和尾随空格、不使用块注释、不硬编码文档链接,且注释内容从 % 起不超过 75 字符(语法行豁免)。段落顺序为 H1 行、发布兼容性(如适用)、语法段、示例(可选)、See Also 行、Note(可选),最后以空行与版权行分隔。名称使用帮助大小写(全小写或首字母大写其余小写的名称转为大写,其他保留原拼写);语法按“必选→可选→名称-值”逐段展开,输出一次只增加一个,可使用 ... 缩写。属性须有注释,公开方法写完整帮助,受保护/私有方法仅写 H1;getter/setter、构造函数等仅写 H1;子类覆写可继承父类帮助以免重复。
使用方式:先解析 $file 为 M 文件路径,若失败可通过 MCP 调用 which("$file") 解析;读取文件,识别 function/classdef/script,若有 arguments 块则据此确定必选、可选和名称-值参数,然后起草帮助文本并校验行宽、段落顺序和缩进,先呈现给用户审核,批准后再用 Edit 写入文件。
限制:仅适用于 MATLAB 帮助注释,不写通用文档或 README,不生成具体代码实现,不处理非 MATLAB 语言;需先成功解析文件路径,无法解析时应报告失败并请用户提供有效路径。其他细节(如价格、平台支持范围)暂未提供。