matlab 函数头注释规范

本文介绍了MATLAB函数头注释的规范,包括函数功能、参数介绍、示例、注意事项、版权信息和日志信息的编写要求。建议在不同部分之间空一行,二级信息可缩进。版权信息中推荐留下联系方式,但为防垃圾邮件,通常用#代替@。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

matlab函数头注释分为以下几部分:

  1. 函数功能简要说明
  2. 函数参数简要介绍
  3. 举例
  4. 注意事项或建议
  5. 版权信息
  6. 日志信息

注意

  1. 在不同的注释部分之间最好能够空一行,但为了能够保证注释的连续性,仍然保持这一行为注释行。每一部分的注释,如果有二级信息,可以空两格进行缩进。
  2. 版权信息中最好能够留着邮箱,这样方便使用你的代码的人在遇到问题时跟你联系,但为了防止垃圾邮件,一般用#替换@。

例子

    常见的size函数的头注释

%SIZE   Size of array.  
%   D = SIZE(X), for M-by-N matrix X, returns the two-element row vector
%   D = [M,N] containing the number of rows and columns in the matrix.
%   For N-D arrays, SIZE(
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值