matlab函数头注释分为以下几部分:
- 函数功能简要说明
- 函数参数简要介绍
- 举例
- 注意事项或建议
- 版权信息
- 日志信息
注意
- 在不同的注释部分之间最好能够空一行,但为了能够保证注释的连续性,仍然保持这一行为注释行。每一部分的注释,如果有二级信息,可以空两格进行缩进。
- 版权信息中最好能够留着邮箱,这样方便使用你的代码的人在遇到问题时跟你联系,但为了防止垃圾邮件,一般用#替换@。
例子
常见的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(