MATLAB 函数签名器

文章目录

  • MATLAB 函数签名器
    • 注释规范
      • 模板
      • 参数类型 kind
      • 数据格式 type
      • 选项的支持
    • 使用
      • 可执行程序
      • 封装为m函数
      • 程序输出
    • 编译
    • 待办事项
    • 推荐阅读
    • 附录

MATLAB 函数签名器

MATLAB 函数签名器 (FUNCSIGN) ，在规范注释格式的基础上为函数文件或类文件自动生成函数签名，并保存至functionSignatures.json。

函数签名能够允许使用者在编辑器调用这些（自定义）函数的时候具备代码提示和自动填充功能，提升编程体验，更多介绍请阅读 自定义代码建议和自动填充 - MATLAB & Simulink - MathWorks 中国。

👍自定义函数代码提示与自动填充：
在这里插入图片描述
在这里插入图片描述

注释规范

模板

为了简化自动化步骤，需要对MATLAB的函数文件和类文件的注释格式进行一定的限制和规范，以下为文件注释模板：

function returnValue = functionName(R1, R2, R3, O1, O2, varargin)
%functionName 函数的简要说明
%
% 函数详细说明
%
% Syntax: (这里添加函数的调用格式, `[]`的内容表示可选参数)
%	returnValue = functionName(R1, R2, R3 ...
%							[, O1, O2 ...
%							 , 'Coeff', 100 ...
%							 , 'k', 1.0 ...
%							 , "Method", "way1"]);
%
% Params:
%   - R1     [required]  [[char], [string]]  R1是char或string
%   - R2     [required]  [numeric; size=2,2] R2为一个2x2的数值矩阵,注意用分号隔开
%   - R3     [required]                      可以省略参数数据格式
%   - O1     [ordered]   [numeric; vector]   可选参数O1
%   - O2     [ordered]   [numeric; nrows=2]  可选参数O2, 函数简要描述将会被记录
%			 可在此处添加O2的详细说明，但是不会被记录到json文件中。
%
%   - Coeff  [namevalue] [numeric]           namevalue对
%            当一个函数存在太多参数设置时, 推荐使用namevalue, 提高可读性, 不需要记忆函
%            数参数位置;
%	- k		 [namevalue] [[numeric], [numeric, choices]] 选项设置
%				* 1.0 可添加选项简要描述, 但是不会别记录
%				* 2.0 没有用引号括起的选项不能包含空格
%				* 3.0 程序会尝试将选项转换为数值，若失败则转换为字符串
%   - Method [namevalue] [char; choices]           选项设置
%  		* 'way1' 方法1
%			选项之间可换行或添加其他说明
%
%       * 'way2' 方法2
%
% Return:
%   - returnValue 返回值
%
% Note:
%   这里可以添加其他描述
%
% Matlab Version: R2021b
%
% See also:
%   myadd, myfun, myfun2, myfun3returnValue = R1; % 正式代码与注释之间留一个空行end

关于模板的几点要求❗和建议✔ ：

  • ❗ 函数文件和类文件必须遵循MATLAB语法规则，不能有语法错误：

    • 函数文件function必须位于文件首行，且函数名需与函数文件名保持一致；

    • 类文件classdef 位于文件首行且类名与类文件名一致；

  • ✔ 建议文件注释从文件第二行开始，% 从第一列开始，后跟函数名或类名以及文件简要描述；

  • ✔注释中存在一些关键字，例如 Syntax 后跟函数调用格式，Params后跟函数输入参数描述，Return 后跟返回值等。这些关键字中只有 Params 是必要的，其他关键字是可选的（也就是说可以自定义增删减改）；

  • ❗ Params关键字后为函数参数描述内容。注释模板必须要有关键字 Params （关键字后可以紧跟冒号:），程序检测到Params关键字后才会解析后续行的函数参数描述，直到注释结束或检测到一个新的关键字；

  • ❗ 在 Params 后，其他关键字之前的行为函数参数描述，函数的每一个输入参数都需要独立占一行，并且按照如下格式：

    参数标识符 参数名称 [参数类型] [数据格式] 参数简要说明

    • 参数标识符 默认为 -，检测到此标识符的行才会被解析，否则会跳过此行的，因此允许函数参数描述行之间添加一些对参数的具体描述（具体例子见模板）；

    • [参数类型] 和 [数据格式] 可以省略，程序会用默认值（[required]和[numeric]）进行替代，但是两者不能互换位置；

    • 参数简要说明 会被记录到 json 文件；

  • ✔ 文件注释结尾处与代码之间留一个空行；

参数类型 kind

与 自定义代码建议和自动填充 - MATLAB & Simulink - MathWorks 中国 规定相同，目前支持以下三种类型：

  • required 参数是必需的，其位置相对于签名对象中的其他必需参数；
  • orderd 参数是可选的，其位置相对于签名对象中的必需参数和前面的可选参数；
  • namevalue 参数是可选的名称-值对组，名称-值对组参数出现在函数签名的末尾，但这些对组可以按任意顺序指定。

✔ 参数类型可以使用首字母缩写，即[r]/[R]来表示[required]，[o]/[O]来表示[orderd]，[n]/[N]来表示[namevalue]；

✔ 参数类型 kind 可以省略，默认为 [required]；

❗ 参数类型 kind 必须位于数据格式 type 之前；

❗ 根据 MATLAB 的要求，函数参数需要按照 required、orderd、namevalue类型依次排列，即函数输入先放必要参数，再放可选参数，最后放namevalue参数。

数据格式 type

与 自定义代码建议和自动填充 - MATLAB & Simulink - MathWorks 中国 基本一致，但又有几点不同，我们将结合 MATLAB 的说明文档进行说明：

type 属性可以定义参数是哪个类以及参数必须具有哪些属性。

  • 要匹配一个类或属性，请使用单个 JSON 字符串。例如，如果参数必须是数值，则指定 "type":"numeric"。

    注释数据格式为 [numeric]

  • 要匹配所有类或属性，请使用 JSON 字符串列表。例如，如果某个参数必须既是数值又是正数，则指定 "type":["numeric", ">=0"]。

    注释数据格式为 [numeric; >=0]

  • 要匹配多个类或属性中的任意多个，请使用 JSON 字符串列表的列表。在内层列表，MATLAB 对各值执行逻辑 AND 运算。在外层列表，MATLAB 对各值执行逻辑 OR 运算。例如，如果参数必须要么是正数，要么是 containers.Map 对象，则指定 "type":[["numeric", ">=0"],["containers.Map"]]

    注释数据格式为 [[numeric; >=0], [containers.Map]]

  • 提供参数选项 ["char", "choices={'way1', 'way2'}"]

    注释数据格式为 [char; choices]，选项由选项行提供

注释数据格式总结为：

  1. 不需要使用引号括起每一项；
  2. 同一列表之间项用 ; 隔开，它们是并&&的关系；
  3. 不同列表之间用,隔开，不同列表是或 || 的关系；
  4. 全新的选项支持

✔ 数据格式 kind 可以省略，则默认为 [numeric]。

❗ 数据格式 kind 必须位于参数类型 kind 之后。

选项的支持

当数据格式中包含 choices时，程序会将此行(包含choices)与下一个包含参数描述/关键字的行之间的行识别为选项行。每一个选项独占一行，选项的描述格式为：

选项标识符 选项名称 选项说明
  • 选项标识符 默认为 *，检测到此标识后此行才会被解析，因此选项之间可以留空或者添加具体的选项描述；
  • 选项名称 选项名称可以用'或"括起（选项名称可以有空格），或者不用引号（选项名称不允许有空格），选项名称会被记录到 json，程序会尝试将选项名称转换为数字（如果可以），若转换失败则为字符串；
  • 选项说明 选项简要说明，不会记录到 json，也可以不写。

❗ 选项标识符不能与参数标识符相同！

例 1：

- Method [namevalue] [choices] 选择一个方法* 'add'       方法1* 'subtract'  方法2* 'multi'     方法3

转换 json 字符串为 "choices={'add', 'subtract', 'multi'}"

例 2：

- Method [R] [char; choices] 选择一个方法* add       方法1* subtract  方法2* multi     方法3

转换 json 字符串为 "char", "choices={'add', 'subtract', 'multi'}"

例 3：

- Coeff [R] [int; choices] 选择一个方法* 1       * 2* 3

转换 json 字符串为 "int", "choices={1, 2, 3}"

使用

可执行程序

可执行程序为 dst/signfunc.exe，其运行指令为

signfun.exe <DirPath> [-ag -] [-op *] [-ver 1.0.0] [-info on/off]  [-kind required] [-type numeric]

其中，必须指定目标文件夹的路径 DirPath，其他几项为可选项:

  • -ag 是参数标识符，默认为 -
  • -op 是选项标识符，默认为 *
  • -ver 是签名文件的版本呢信 息，默认为 1.0.0
  • -log 是否输出详细信息，默认为 on
  • -kind 设置默认参数kind，默认为 required，不建议修改
  • -type 设置默认参数type，默认为 numeric，不建议修改

❗ 注意，需要将可执行程序的路径添加到系统环境路径中。

封装为m函数

封装的m函数为 dst/hs_signfunc.m，其调用格式为

status = hs_signfunc(dir_path ...[, "Verbose", true ..., "ArgSym", '-' ..., "OptSym", '*' ..., "Version", "1.0.0" ..., "DefaultKind", 'required' ..., "DefaultType", {"numeric"}]);

具体的函数参数说明见函数文件 hs_signfunc.m。

注意：

  • ❗ 需要将可执行程序 signfunc.exe 的路径添加到系统环境路径中；

  • ❗ 需要将m函数文件 hs_signfunc.m 添加到 MATLAB 路径中。

程序输出

程序运行后会在指定目录下生成函数签名文件 functionSignatures.json 和日志文件 funcsigner.log。

可以调用 validateFunctionSignaturesJSON(json_path) 来检验函数签名文件格式是否正确。检查格式无误后，可能需要重启 MATLAB 才能激活自定义函数代码提示功能。

编译

  • 源码：https://gitee.com/iam002/funcsign

  • 编译环境：

    • VSCode + cmake插件+ cpp插件
    • cmake
    • VS 2019 amd64

    ✔ 软件安装好后，打开VSCode进入当前文件夹，打开命令面板，执行 cmake configure，在底部改为Release模式，再执行 cmake build target 后选择 install。

  • 依赖第三方库（已放置到 thirdparty）

    • easyloggingpp
    • jsoncpp

当然，也可以通过命令行的方式进行编译

mkdir build
cd build
cmake  -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --config Release -A x64
cmake install

等待编译完成后可执行程序保存在 dst，将其添加到系统路径和MATLAB路径，即可使用。

待办事项

  • 由于 jsoncpp 不能按照插入顺序进行输出，在调用 validateFunctionSignaturesJSON 会有如下信息。但经实测，函数签名仍有效；

    “_schemaVersion” 必须是文件中的第一个属性。

  • 为什么不提供 mex 文件

    mex 接口对中文支持实在不友好，输入到终端的字符顺序又有点乱😂，目前还没有解决方法；使用 system 调用可执行程序已经很好满足需求了，不再考虑通过mex来封装了。

  • 跨平台支持

推荐阅读

  • 自定义代码建议和自动填充 - MATLAB & Simulink - MathWorks 中国
  • 验证 functionSignatures.json 文件 - MATLAB validateFunctionSignaturesJSON - MathWorks 中国
  • 声明函数参数验证 - MATLAB arguments - MathWorks 中国
  • iam002/funcsign (gitee.com)

附录

注释模板的函数签名文件：

{"_schemaVersion" : "1.0.0","functionName" : {"inputs" : [{"kind" : "required","name" : "R1","purpose" : "R1是char或string","type" : [["char"],["string"]]},{"kind" : "required","name" : "R2","purpose" : "R2为一个2x2的数值矩阵,注意用分号隔开","type" : ["numeric","size=2,2"]},{"kind" : "required","name" : "R3","purpose" : "可以省略参数数据格式","type" : ["numeric"]},{"kind" : "ordered","name" : "O1","purpose" : "可选参数O1","type" : ["numeric","vector"]},{"kind" : "ordered","name" : "O2","purpose" : "可选参数O2, 函数简要描述将会被记录","type" : ["numeric","nrows=2"]},{"kind" : "namevalue","name" : "Coeff","purpose" : "namevalue对","type" : ["numeric"]},{"kind" : "namevalue","name" : "k","purpose" : "选项设置","type" : [["numeric"],["numeric","choices={1.0, 2.0, 3.0}"]]},{"kind" : "namevalue","name" : "Method","purpose" : "选项设置","type" : ["char","choices={'way1', 'way2'}"]}]}
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.rhkb.cn/news/148949.html

如若内容造成侵权/违法违规/事实不符，请联系长河编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

select完成服务器并发

select完成服务器并发

服务器 #include <myhead.h>#define PORT 4399 //端口号 #define IP "192.168.0.191"//IP地址//键盘输入事件 int keybord_events(fd_set readfds); //客户端交互事件 int cliRcvSnd_events(int , struct sockaddr_in*, fd_set *, int *); //客户端连接事件 …
阅读更多...
国庆day5

国庆day5

客户端 #include "widget.h" #include "ui_widget.h"Widget::Widget(QWidget *parent): QWidget(parent), ui(new Ui::Widget) {ui->setupUi(this);socket new QTcpSocket(this);//此时&#xff0c;已经向服务器发送连接请求了&#xff0c;如果成功连…
阅读更多...
第一百六十四回 如何实现NumberPicker

第一百六十四回 如何实现NumberPicker

文章目录 1.概念介绍2.使用方法2.1 NumberPicker2.2 CupertinoPicker 3.示例代码4.内容总结 我们在上一章回中介绍了"如何在任意位置显示PopupMenu"相关的内容&#xff0c;本章回中将介绍如何实现NumberPicker.闲话休提&#xff0c;让我们一起Talk Flutter吧。 1.概…
阅读更多...
【重拾C语言】四、循环程序设计（后判断条件循环、先判断条件循环、多重循环；典例：计算平均成绩、打印素数、百钱百鸡问题）

【重拾C语言】四、循环程序设计（后判断条件循环、先判断条件循环、多重循环；典例：计算平均成绩、打印素数、百钱百鸡问题）

目录 前言 四、循环程序设计 4.1 计算平均成绩——循环程序 4.1.1 后判断条件的循环 a. 语法 b. 典例 4.1.2 先判断条件的循环 a. 语法 b. 典例 4.1.3 for语句 a. 语法 b. 典例 4.2 计算全班每人平均成绩—多重循环 4.2.1 打印100以内素数 4.2.2 百钱百…
阅读更多...
System Generator学习——使用 AXI 接口和 IP 集成器

System Generator学习——使用 AXI 接口和 IP 集成器

文章目录 前言一、目标二、步骤1、检查 AXI 接口2、使用 System Generator IP 创建一个 Vivado 项目3、创建 IP 集成设计&#xff08;IPI&#xff09;4、实现设计 总结 前言 在本节中&#xff0c;将学习如何使用 System Generator 实现 AXI 接口。将以 IP 目录格式保存设计&am…
阅读更多...
【MATLAB-基于直方图优化的图像去雾技术】

【MATLAB-基于直方图优化的图像去雾技术】

【MATLAB-基于直方图优化的图像去雾技术】 1 直方图均衡2 程序实现3 局部直方图处理 1 直方图均衡 直方图是图像的一种统计表达形式。对于一幅灰度图像来说&#xff0c;其灰度统计直方图可以反映该图像中不同灰度级出现的统计情况。一般而言&#xff0c;图像的视觉效果和其直方…
阅读更多...
HUAWEI悦盒ec6108v9c 如何刷成海纳思系统(家用低功耗服务器，使用Home Assistant服务)

HUAWEI悦盒ec6108v9c 如何刷成海纳思系统(家用低功耗服务器，使用Home Assistant服务)

环境&#xff1a; 1.HW悦盒ec6108v9c一套 2.16G U盘 3.格式化软件USB_format.exe 4.固件 mv100-mdmo1g-usb-flash.zip&#xff08;底层是Ubuntu 20.04系统&#xff09; 5.十字螺丝刀 6.翘片/薄铲子 7.有线网络环境 8.镊子/回形针 问题描述&#xff1a; 最近玩智能家居…
阅读更多...
OpenCV项目开发实战--使用最先进的方法“F、B、Alpha Matting”进行图像抠图--提供完整代码

OpenCV项目开发实战--使用最先进的方法“F、B、Alpha Matting”进行图像抠图--提供完整代码

示范 让我们对现实生活中的图像启动 FBA Matting 方法。要应用 FBA Matting 算法，我们首先需要生成一个 trimap（我们稍后会介绍它是什么）。在我们的演示中，我们将使用预训练的DeepLabV3生成分割掩模，其中每个像素属于前景类的概率。之后，我们将使用大量膨胀操作将边界像…
阅读更多...
面向无线传感器网络WSN的增强型MODLEACH设计与仿真（Matlab代码实现）

面向无线传感器网络WSN的增强型MODLEACH设计与仿真（Matlab代码实现）

&#x1f4a5;&#x1f4a5;&#x1f49e;&#x1f49e;欢迎来到本博客❤️❤️&#x1f4a5;&#x1f4a5; &#x1f3c6;博主优势&#xff1a;&#x1f31e;&#x1f31e;&#x1f31e;博客内容尽量做到思维缜密&#xff0c;逻辑清晰&#xff0c;为了方便读者。 ⛳️座右铭&a…
阅读更多...
QT4.8.7安装详细教程

QT4.8.7安装详细教程

QT4.8.7安装详细教程&#xff08;MinGW 4.8.2和QTCreator4.2.0&#xff09; 1.下载及安装2.配置环境 此文是在下方链接博文的基础上&#xff0c;按自己的理解整理的https://blog.csdn.net/xiaowanzi199009/article/details/104119265 1.下载及安装 这三个文件&#xff0c;顺序是…
阅读更多...
微信小程序代驾系统源码（含未编译前端，二开无忧） v2.5

微信小程序代驾系统源码（含未编译前端，二开无忧） v2.5

简介&#xff1a; 如今有越来越多的人在网上做代驾&#xff0c;打造一个代驾平台&#xff0c;既可以让司机增加一笔额外的收入&#xff0c;也解决了车主酒后不能开发的问题&#xff0c;代驾系统基于微信小程序开发的代驾系统支持一键下单叫代驾&#xff0c;支持代驾人员保证金…
阅读更多...
Elasticsearch安装访问

Elasticsearch安装访问

Elasticsearch 是一个开源的、基于 Lucene 的分布式搜索和分析引擎&#xff0c;设计用于云计算环境中&#xff0c;能够实现实时的、可扩展的搜索、分析和探索全文和结构化数据。它具有高度的可扩展性&#xff0c;可以在短时间内搜索和分析大量数据。 Elasticsearch 不仅仅是一个…
阅读更多...
C++ 类和对象篇(四) 构造函数

C++ 类和对象篇(四) 构造函数

目录 一、概念 1. 构造函数是什么&#xff1f; 2. 为什么C要引入构造函数&#xff1f; 3. 怎么用构造函数&#xff1f; 3.1 创建构造函数 3.2 调用构造函数 二、构造函数的特性 三、构造函数对成员变量初始化 0. 对构造函数和成员变量分类 1. 带参构造函数对成员变量初始化 2. …
阅读更多...
MyBatisPlus（十一）判空查询：in

MyBatisPlus（十一）判空查询：in

说明 判空查询&#xff0c;对应SQL语句中的 in 语句&#xff0c;查询参数包含在入参列表之内的数据。 in Testvoid inNonEmptyList() {// 非空列表&#xff0c;作为参数List<Integer> ages Stream.of(18, 20, 22).collect(Collectors.toList());in(ages);}Testvoid in…
阅读更多...
Gorsonpy的计算器

Gorsonpy的计算器

Gorsonpy的计算器 0.页面及功能展示1. PSP表格2.解题思路描述3.设计实现过程4.程序性能改进5.异常处理6.单元测试展示7.心路历程和收获 这个作业属于哪个课程https://bbs.csdn.net/forums/ssynkqtd-05这个作业要求在哪里https://bbs.csdn.net/topics/617294583这个作业的目标完…
阅读更多...
手边酒店V2独立版小程序 1.0.21 免授权+小程序前端

手边酒店V2独立版小程序 1.0.21 免授权+小程序前端

手边酒店小程序独立版酒店宾馆订房系统支持创建多个小程序&#xff0c;让每一个客户单独管理属于自己的小程序。后台支持一键入住&#xff0c;一键退款、退押金、钟点房支持微信支付、模板消息。客服实时收到新的订单信息&#xff0c;可以在手机端处理订单。支持按日期维护房价…
阅读更多...
基于SpringBoot的智能推荐的卫生健康系统

基于SpringBoot的智能推荐的卫生健康系统

目录 前言 一、技术栈 二、系统功能介绍 用户管理 科室类型管理 医生信息管理 健康论坛管理 我的发布 我的收藏 在线咨询 三、核心代码 1、登录模块 2、文件上传模块 3、代码封装 前言 随着信息技术在管理上越来越深入而广泛的应用&#xff0c;管理信息系统的实施在…
阅读更多...
python+pygame+opencv+gpt实现虚拟数字人直播（一）

python+pygame+opencv+gpt实现虚拟数字人直播（一）

AI技术突飞猛进&#xff0c;不断的改变着人们的工作和生活。数字人直播作为新兴形式&#xff0c;必将成为未来趋势&#xff0c;具有巨大的、广阔的、惊人的市场前景。它将不断融合创新技术和跨界合作&#xff0c;提供更具个性化和多样化的互动体验&#xff0c;成为未来的一种趋…
阅读更多...
2023年【道路运输企业主要负责人】试题及解析及道路运输企业主要负责人复审考试

2023年【道路运输企业主要负责人】试题及解析及道路运输企业主要负责人复审考试

题库来源&#xff1a;安全生产模拟考试一点通公众号小程序 道路运输企业主要负责人试题及解析参考答案及道路运输企业主要负责人考试试题解析是安全生产模拟考试一点通题库老师及道路运输企业主要负责人操作证已考过的学员汇总&#xff0c;相对有效帮助道路运输企业主要负责人…
阅读更多...
分布式操作系统

分布式操作系统

分布式操作系统属于多机操作系统&#xff0c;能够统一一套计算机集群&#xff0c;相比单机系统&#xff0c;分布式操作系统在管理计算机集群方面要简单很多。各种分布式的基础功能&#xff0c;都集中到分布式操作系统来实现&#xff0c;而不是单机系统的应用软件来实现&#xf…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023

友情链接： 我的编程经验分享 一条长河网 尧图网站开发