向代码添加注释
编写代码时,最好添加描述代码的注释。注释有助于其他人员理解您的代码,并且有助您在稍后返回代码时再度记起。在代码开发和测试期间,您还可以使用注释来注释掉任何不需要运行的代码。
在实时编辑器中,您可以在代码前后插入文本行来描述过程或代码。文本行还提供其他灵活的功能,例如标准格式设置选项以及插入图像、超链接和方程。有关详细信息,请参阅在实时编辑器中创建实时脚本。
注意
如果您 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+Shift+R。在 macOS 系统上,使用 Command+/ 进行注释,使用 Command+Option+/ 取消注释。在 Linux® 系统上,使用 Ctrl+/ 进行注释,使用 Ctrl+Shift+/ 取消注释。
要注释掉跨多行的部分语句,请使用省略号 (...
) 代替百分比符号。例如:
header = ['Last Name, ', ... 'First Name, ', ... ... 'Middle Initial, ', ... 'Title']
注释换行
默认情况下,您在编辑器和实时编辑器中键入注释时,文本在列宽度达到 75 时换行。编辑器和实时编辑器不会对以下注释换行:
节标题(以
%%
开头的注释)长的连续文本,例如 URL
前一行含项目符号列表项(以
*
或#
开头的文本)
要更改注释文本换行位置或者要禁用自动注释换行,请转到主页选项卡,然后在环境部分,点击 预设项。选择 MATLAB > 编辑器/调试器 > 语言,然后调整注释格式设置预设项。在 MATLAB Online™ 中,这些预设项位于编辑器/调试器 > MATLAB 语言下。
如果您的现有注释超出当前列宽,要将注释自动换行,请转至编辑器或实时编辑器选项卡,在代码部分中,点击注释换行按钮 。例如,假设您在注释的行中输入以下长文本。
% This is a code file that has a comment that is a little more than 75 columns wide. disp('Hello, world')
% This is a code file that has a comment that is a little more than 75 % columns wide. disp('Hello, world')
检查注释中的拼写
您可以检查注释中的拼写问题。要启用拼写检查,请转至视图选项卡并点击拼写按钮。可能存在拼写问题的单词带有蓝色下划线。要解决该问题,请点击该单词并选择建议的更正之一。您也可以选择忽略该问题或将标记的单词添加到您的本地字典中。要使用键盘在问题之间导航,请使用 Alt+F7 和 Alt+Shift+F7。
在 MATLAB 代码文件 (.m
) 和实时代码文件 (.mlx
) 中支持美国英语的拼写检查。要从本地字典中删除单词,请转至 MATLAB 预设项文件夹(运行 prefdir
时返回的文件夹)并编辑文件 dict/en_US_userDictionary.tdi
。