发布MATLAB时®代码文件(.m
),你可以通过在文件的注释中添加标记来增强已发布文档的可读性。通过添加标记,可以对发布的文档进行格式化,并显示外部文件和图形。
要插入标记,可以:
控件上的格式化按钮和下拉菜单发布标签格式化文件。此方法会自动为您插入文本标记。
从中选择标记插入文本标记列表在右键单击菜单中。
在注释中直接键入标记。
下表提供了文本标记选项的摘要。如果您不使用MATLAB编辑器,或者如果您不想使用的话,请参阅此表发布选项卡以应用标记。
请注意
使用标记时:
评论符号后的空格(%
)常常决定接下来文章的格式。
启动新标记通常需要前面的空白注释行,如示例中所示。
标记仅在评论中工作,即立即遵循部分休息。
导致输出 | 相应文件标记的示例 | ||||
---|---|---|---|---|---|
部分和部分标题 |
% %节标题%的描述性文字 %%%章节标题没有部分破坏%描述性文本 |
||||
文本格式 |
%_ITALIC Text_ % *粗体文字* %| MONOSOCED文本| %商标:%文本(TM) %文本(r) |
||||
项目符号和编号列表 |
%%项目符号列表%*项目符号项1%*项目符号项2% %%编号列表%% #编号项目1 % #编号项目2 % |
||||
文本和代码块 |
%%%preformatted%text% %% matlab(r)代码%%= 1:10%disp x%ex% |
||||
外部文件内容 |
%% |
||||
外部图形 |
%%<< filename.png >>% |
||||
图像快照 |
snapnow; |
||||
乳胶方程 |
%%内联表达式%$ x ^ 2 + e ^ {\ pi i} $ %%块方程%% $$ ^ {\ pi i} + 1 = 0 $$% |
||||
超链接 |
MathWorks % < //www.tatmou.com > % < matlab:函数DISPLAYED_TEXT > |
||||
HTML标记 |
%% %<表边框= 1> |
代码段允许您组织、添加注释和执行代码的各个部分。代码段以双百分号开头(% %
)然后是一个可选的部分标题。部分标题显示为顶级标题(h1
在HTML中,使用较大,粗体字体。
请注意
您可以在标题后立即添加评论。但是,如果您想要整体文档标题,则无法在下一节开始前添加任何MATLAB代码(从中开头的行% %
).
例如,此代码在发布时会产生优选的结果。
%% Vector Operations%您可以在向量上执行许多二进制操作。%% a = 1:3;B = 4:6;%% DOT产物%两载体的点产物产生标量。MATLAB有一个简单的点积命令。下载188bet金宝搏s =点(a,b);%%十字产物%两种载体的十字产物产生垂直于原始载体的第三%载体。MATLAB再次对跨产品有一个简单的命令。下载188bet金宝搏v =十字架(a,b);
通过保存编辑器中的代码并单击发布按钮发布选项卡,MATLAB产生输出,如图所示。请注意,MATLAB会自动从MATLAB文件中的标题中插入内容菜单。
您可以在MATLAB注释中标记所选文本,以便在发布文件时以Italic,Bold或Monosped文本显示。简单地包围文字_
,*
, 或者|
对于斜体,粗体或单级文本。
例如,这些行显示发布后的每一个文本格式化语法。
%%计算和绘制正弦波%_define_ *范围* for | x |
如果MATLAB文件中的注释包括商标条款,您可以在输出中包含文本以在输出中生成商标符号(™)或注册商标符号(®)。只是补充.(右)
或者(TM值)
直接在问题术语后,没有任何空间。
例如,假设您在文件中输入这些行。
MATLAB(R)%中的%%基本矩阵操作这是MATLAB(R)%和符号数学工具箱(TM)的某些方面的演示。
如果将文件发布到HTML,则会显示在MATLAB Web浏览器中。
MATLAB允许在注释中添加项目符号和编号列表。可以使用此语法生成项目符号和编号列表。
%%两个列表%% * item1%* item2%#item1%#item2%
发布示例代码会产生此输出。
预格式化的文本出现在Monospace字体中,维护空白空间,并且不会缠绕长线。在注释符号和预格式化文本的第一行的文本之间,必须出现两个空格。
发布此代码会产生预格式化的段落。
许多人发现等间距文本更容易阅读:两个向量的点积产生一个标量。MATLAB有一个简单的点积命令。下载188bet金宝搏
可执行代码显示在已发布的文档中突出显示语法。你也可以突出显示示例代码.示例代码是注释中显示的代码。
要表示示例代码,必须在注释符号和第一行代码的开始处放三个空格。例如,单击代码按钮发布选项卡将在编辑器中插入以下示例代码。
%%%%= 1:10%DISP(x)%end%
将此代码发布到HTML生成MATLAB Web浏览器中的输出。
要将外部文件内容添加到Matlab发布的代码中,请使用<包括>
标记。指定相对于发布文件位置的外部文件路径。包括MATLAB代码文件发布为语法突出显示的代码。以纯文本形式发布的任何其他文件。
例如,此代码插入内容sine_wave.m
进入发布的输出:
%%外部文件内容示例%此示例包括sine_wave.m的文件内容进入发布% 输出。%%sine_wave.m 包含> %%上面的文件内容是正确的语法突出显示
将文件发布到HTML。
要发布MATLAB代码未生成的图像,请使用文本标记。默认情况下,MATLAB已包含代码生成的图形。
此代码插入称为通用图像filename.png.
进入您发布的输出。
%% %% << filename.png >>%
matlab要求filename.png.
是从输出位置到外部图像的相对路径或完全限定的URL。良好做法是在Matlab发布其输出的同一文件夹中保存图像。例如,MATLAB将HTML文档发布到子文件夹HTML.
.在同一子文件夹中保存图像文件。您可以通过更改发布配置设置来更改输出文件夹。在Matlab Online™,将您的图像文件保存到您的图像文件发表
文件夹,位于根文件夹中。
冲浪(山峰)
此示例显示了如何插入surfpeaks.jpg.
进入MATLAB文件进行发布。
创建surfpeaks.jpg.
,在命令窗口中运行此代码。
野生动物(海浪(峰),'surfpeaks.jpg');
生成包含的HTML文件surfpeaks.jpg.
来自MATLAB文件:
创建一个调用的子文件夹HTML.
在您当前的文件夹中。
创建surfpeaks.jpg.
通过在命令窗口中运行此代码。
SaveAs(Surf(峰),'html / surfpeaks.jpg');
将此MATLAB代码发布到HTML。
%%图像示例%这是一个图形:%% << surfpeaks.jpg >>%
发布时,您可以包含的图像类型取决于该文档的输出类型,如此表格所示。有关最大的兼容性,最佳实践是为每个输出类型使用默认图像格式。
输出文件格式 | 默认图像格式 | 可以包含的图像类型 |
---|---|---|
博文 |
PNG. |
您已安装版本的任何格式微软®办公室金宝app支持。 |
HTML. |
PNG. |
所有格式成功发布。确保您用于查看和处理输出文件的工具可以显示您指定的输出格式。 |
乳胶 |
PNG. 或者EPSC2. |
所有格式成功发布。确保您用于查看和处理输出文件的工具可以显示您指定的输出格式。 |
pdf |
BMP. |
|
PPT. |
PNG. |
您已安装版本的任何格式微软办公软件金宝app支持。 |
xml |
PNG. |
所有格式成功发布。确保您用于查看和处理输出文件的工具可以显示您指定的输出格式。 |
您可以插入捕获MATLAB输出快照的代码。例如,这是有用的,如果你有一个为
循环,该循环修改您希望在每次迭代后捕获的图形。
以下代码运行a为
循环三次并在每次迭代后产生输出。这Snapnow.
Command捕获代码生成的所有三个图像。
%%缩放魔术数据和显示为i = 1:3 ImagesC(Magic(i))SnapNow;结尾
如果将文件发布到HTML,则它类似于以下输出。默认情况下,HTML中的图像大于图中所示。要调整Matlab代码生成的图像大小,请使用最大图像宽度和最大图像高度田野在发布设置窗格,如发布的输出首选项.
MATLAB使您能够在打算发布的任何代码中包含内联LaTeX表达式。要插入内联表达式,请在LaTeX标记周围加上美元符号字符($
).这$
必须立即在内联表达式的第一个单词之前,并立即遵循内联表达式的最后一个单词,而不会介于其中任何空间。
请注意
除Microsoft PowerPoint外,所有发布输金宝app出类型都支持乳胶表达式®.
Matlab Publishing支金宝app持标准乳胶数学模式指令。不支持需要其他包的文本模式指令或指令。金宝app
此代码包含乳胶表达式:
%%乳胶内联表达式实例%%这是一个等式:$ x ^ 2 + e ^ {\ pi i} $。它与文本为大纲。
如果将示例文本标记发布到HTML,则结果输出如下所示。
MATLAB使您可以在从主注释文本中偏移的块中插入乳胶符号。两个美元的符号字符($$
)表示一个块状LaTeX方程。在不同的块中发布方程需要块之间有空白行。
此代码是示例文本标记。
%%乳胶等式示例%%这是一个等式:%% $$ ^ {\ pi i} + 1 = 0 $$ %%它不与文本一致。
如果发布到HTML,则表达式显示如此。
您可以在Matlab评论中插入静态超链接,然后将文件发布到HTML,XML或微软文字处理软件.当指定到web位置的静态超链接时,在代码中包含一个完整的URL。当你想把读者指向一个网页位置时,这很有用。您可以在发布的文本中显示或隐藏URL。当您确信读者正在在线查看您的输出并且可以单击超链接时,可以考虑排除URL。
括在角度括号中的URL和任何替换文本。
更多信息,请参阅我们的网站:% /www.tatmou.com MathWorks>
将代码发布到HTML生成此输出。
消除文本Mathworks.
URL生成此修改后的输出后。
请注意
如果您的代码在MATLAB Command Window中生成超链接文本,输出将显示HTML代码而不是超链接。
您可以插入动态超链接,Matlab在读者点击该链接时评估。动态超链接使您可以将读者指向MATLAB代码或文档,或使读者能够运行代码。您使用的是使用这些链接MATLAB:
语法。如果后面的代码MATLAB:
声明有空格,替换它们% 20
.
请注意
动态链接仅在Matlab Web浏览器中查看HTML时工作。
动态链接的不同用途包括:
动态链接到运行代码。您可以指定一个动态超链接,以便在用户单击超链接时运行代码。例如,这个MATLAB:
Syntax在输出中创建超链接,当单击它时启用或禁用回收:
%%回收首选项%单击所需的首选项:%%%
已发布的结果类似于此HTML输出。
当您单击其中一个超链接时,Matlab设置了回收
相应的命令。单击超链接后,运行回收
在命令窗口中确认设置就像您所期望的。
文件的动态链接。您可以指定要知道的文件的链接matlabroot.
你的读者。您不需要知道每个阅读器安装MATLAB的位置。例如,链接到函数代码发布
.
%%%查看%%的发布函数。
接下来,将文件发布到HTML。
当你点击时代码
链接,MATLAB编辑器打开并显示该代码发布
函数。在读者的系统上,MATLAB发出命令(尽管该命令未显示在读者的命令窗口中)。
动态链接到一个马铃薯草功能参考页面。您可以使用使用的链接MATLAB:
语法。例如,假设您的读者安装并运行了MATLAB。提供一个链接发布
参考页面。
%%%查看函数的帮助。
将文件发布到HTML。
当你点击时发布
超链接,MATLAB帮助浏览器打开并显示的参考页面发布
函数。在读者的系统上,MATLAB发出命令,尽管命令没有出现在命令窗口中。
您可以将HTML标记插入MATLAB文件。您必须在没有按钮上键入HTML标记发布选项卡生成它。
请注意
当为HTML代码插入文本标记时,仅当指定的输出文件格式为HTML时,HTML代码才发布。
此代码包括HTML标记。
%% HTML标记示例%这是一个表:%% %