本页对应的英文页面已更新,但尚未翻译。 若要查看最新内容,请点击此处访问英文页面。

向程序中添加注释

编写代码时,最好添加描述代码的注释。注释有助于其他人员理解您的代码,并且有助您在稍后返回代码时再度记起。在程序开发和测试期间,您还可以使用注释来注释掉任何不需要运行的代码。

在实时编辑器中,您可以在代码前后插入文本行来描述过程或代码。文本行还提供其他灵活的功能,例如标准格式设置选项以及插入图像、超链接和方程。有关详细信息,请参阅在实时编辑器中创建实时脚本

注意

如果您 MATLAB® 代码文件 (.m) 中的文本所包含的字符编码与您的平台编码不同,则在您保存或发布文件时,MATLAB 会将这些字符显示为乱码。实时脚本和函数 (.mlx) 支持所有区域设置的存储和字符显示。

要向 MATLAB 代码中添加注释,请使用百分比 (%) 符号。注释行可以显示在程序文件中的任何位置,您也可以在代码行末尾附加注释。

例如:

% Add up all the vector elements.
y = sum(x)           % Use the sum function.

要注释掉多个代码行,请使用块注释运算符 %{%}%{%} 运算符必须单独显示在帮助文本块前后紧邻的行上。不要在这些行中包括任何其他文本。

例如:

a = magic(3);
%{
sum(a)
diag(a)
sum(diag(a))
%}
sum(diag(fliplr(a)))

要注释掉所选内容,请选择代码行,转到编辑器实时编辑器选项卡,然后按 按钮。也可以键入 Ctrl+R。要取消注释所选代码行,请按 按钮或键入 Ctrl+T

要注释掉跨多行的部分语句,请使用省略号 (...) 代替百分比符号。例如:

header = ['Last Name, ',      ...
          'First Name, ',     ...
      ... 'Middle Initial, ', ...
          'Title']

MATLAB 编辑器包括许多工具和上下文菜单项,用来帮助您为 MATLAB、Java® 和 C/C++ 代码添加、删除或更改注释格式。例如,假设您在注释的行中输入以下长文本。

% This is a program that has a comment that is a little more than 75 columns wide.
disp('Hello, world')
将光标放在该行上,转到编辑器选项卡,然后在编辑部分按 按钮。编辑器会对注释进行换行:
% This is a program that has a comment that is a little more than 75
% columns wide.
disp('Hello, world')

按钮在实时编辑器或 MATLAB Online™ 中不可用。

默认情况下,您在编辑器中键入注释时,文本在列宽度达到 75 时换行。要更改注释文本换行位置所在的列或者要禁用自动注释换行,请转到主页选项卡,然后在环境部分,点击 预设。选择 MATLAB > 编辑器/调试器 > 语言,然后调整注释格式设置预设项。

编辑器不会对以下注释换行:

  • 代码节标题(以 %% 开头的注释)

  • 长的连续文本,例如 URL

  • 前一行含项目符号列表项(以 *# 开头的文本)

MATLAB Online 不支持更改注释格式预设项。

相关主题