matlab香蕉函数注释,MATLAB函数头注释规范

注释在编写程序的过程中是至关重要的，尤其是算法比较复杂的程序。除非，你确定你以后一定不会再看这段程序，也不打算让任何人理解你的这段程序。

MATLAB的函数注释是非常重要的。我们通常help一个函数看到的信息就是这个函数的函数头注释。

下面是我在写MATLAB程序过程总结出来的函数头的注释规范，是为了方便自己以后忘了以后查找，如果你恰巧看到这篇文章，也算给你一点参考。

我将MATLB函数头注释分为以下几个部分：

函数功能简要说明

函数参数简要介绍

举例

注意事项或者建议

版权信息

日志信息

在不同的注释部分之间最好能够空一行，但为了能够保证注释的连续性，仍然保持这一行为注释行。每一部分的注释，如果有二级信息，可以空两格进行缩进。

版权信息中最好能够留着邮箱，这样方便使用你的代码的人在遇到问题时跟你联系，但为了防止垃圾邮件，一般用#替换@。

因为日志信息是以后修改可能性比较大的部分，所以用两行注释号突出显示。

下面是一个例子。

function xyz2lmp(f_xyz)

% Convert .xyz file to lammps data file.

%

% xyz2lmp(f_xyz)

% f_xyz: name of the input .xyz file.

%

% Example:

% xyz2lmp('PdAu.xyz')

%

% NOTE: The second line must be in specified format as:

% PdAu xlo xhi ylo yhi zlo zhi

%

%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% log:

% 2011-05-04: Complete

% 2012-08-16: Modify the description and comments

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%