跳转到内容

MATLAB 编程/注释

来自维基教科书,自由的教科书


放置注释

[编辑 | 编辑源代码]

注释行以字符 '%' 开头, '%' 字符后的任何内容都会被解释器忽略。 '%' 字符本身只告诉解释器忽略同一行的其余部分。

在 MATLAB 编辑器中,注释区域默认以绿色显示,因此应该很容易识别。有两种有用的键盘快捷键可用于添加和删除注释块。选择要注释或取消注释的代码,然后按 Ctrl-R (-/ for Mac) 在每行开头放置一个 '%' 符号,按 Ctrl-T (-T for Mac) 执行相反的操作。

MATLAB 还支持多行注释,类似于 C 或 C++ 中的 /* ... */,通过 %{%} 定界符。但有一个细微但重要的区别。在 MATLAB 中,不允许以 %{%} 开头的行包含任何其他文本(空格除外)。否则它将无法正常工作。例如:

%{ for i = 1:10
  disp(i)
end %}

会报错,但是

%{
for i = 1:10
  disp(i)
end
%}

可以正常工作。

常用用法

[编辑 | 编辑源代码]

注释对于解释特定代码段的功能很有用,尤其是在代码依赖于隐式或微妙的假设或以其他方式执行微妙操作时。这样做对你自己和其他人阅读你的代码都是个好主意。例如:

% Calculate average velocity, assuming acceleration is constant
% and a frictionless environment.
force = mass * acceleration

通常建议将解释 M 文件功能以及如何使用它的注释块作为第一行文本。当你输入时,MATLAB 会输出函数定义之前的注释或函数定义内第一个注释块之前的注释

>> help functionname

所有用 MATLAB 编写的 MATLAB 自身函数也以这种方式记录。

注释还可以用于标识作者、参考资料、许可证等等。这样的文本通常位于 M 文件的末尾,但也可能位于开头。最后,注释可以用来帮助调试,如 调试 M 文件 中所述。

华夏公益教科书