添加注释

注释行以字符 % 开头,解释器会忽略 % 后面的所有内容。% 字符本身只是告诉解释器忽略该行剩余部分的内容。

在 MATLAB 编辑器中,注释区域默认以绿色显示,因此很容易识别。有两个非常有用的快捷键可以添加或移除整段注释:
选中你想注释或取消注释的代码,然后按下:

  • Ctrl + R(Mac 为 ⌘ + /):在每行前加一个 %

  • Ctrl + T(Mac 为 ⌘ + T):移除每行前的 %

MATLAB 也支持多行注释,类似于 C 或 C++ 中的 /* ... */,语法为 %{%}
但需要注意一个重要区别:在 MATLAB 中,%{%} 开头的行不能包含其他内容(除了空格),否则注释块将无法正常工作。

例如:

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

会报错,但下面的写法是正确的:

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

常见用途

注释非常有用,特别是当代码依赖于一些隐含或不明显的假设,或者执行了一些不直观的操作时,注释可以帮助解释代码的功能。这对于自己回顾代码或他人阅读代码都很重要。例如:

% 假设加速度恒定,且无摩擦环境下计算平均速度
force = mass * acceleration

建议并常见的做法是在 .m 文件开头使用注释块,说明该文件的用途和使用方法。
当你在 MATLAB 中输入:

>> help 函数名

MATLAB 会输出函数定义之前的注释或函数体内开头的注释块。
MATLAB 自带的函数若是用 MATLAB 编写的,也是通过这种方式进行文档说明的。


注释也可以用于标注作者、引用来源、许可证信息等内容。这类信息通常写在 .m 文件的开头或结尾。

最后,注释还可用于调试过程中暂时屏蔽部分代码,具体用法可参考 Debugging M Files 章节。

最后修改: 2025年04月14日 星期一 18:39