注册 登录  
 加关注
查看详情
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

极夜.潜的博客

 
 
 

日志

 
 

如何为Matlab代码写注释?  

2011-04-26 20:00:57|  分类: Matlab |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |

代码注释是Matlab程序的重要组成部分,按照规定格式注释的代码可在最终发布的Matlab文档中生成列表、表格、超链接、LaTeX公式、图片、程序运行结果等。文档组织有序、结构合理,格式也十分灵活,可以是HTML、LaTeX、MS Office文档等。

一、Matlab代码的重要组织结构——代码单元(code cell)
Matlab用代码单元(cell)为同一个源文件中的代码分段(section)。通过分别对每个单元代码进行注释和调试,使Matlab代码结构更清晰,调试更容易(一个按单元的程序测试例子),同时方便发布Matlab文档。分单元的基本法则是将每个功能(或任务)相对独立的连续代码片段分为一个单元。代码单元支持嵌套。

1、代码单元使用三部曲:
(1)开启:在Editor中 Cell --> Enable Cell Mode;
(2)定义:用双百分号“%%”为代码分单元(单百分号“%”用于程序注释);
(3)使用:按单元调试或注释代码。 

2、代码单元的一些规则:
(1)每个Matlab的m程序文件就是一个隐式的代码单元;
(2)如在某函数内部定义代码单元,该函数自动成为一个隐式的代码单元(没看出来??);
(3)如在某个语句块(if、while等)内部定义代码单元,该语句块及包含该语句块的函数自动成为隐式的代码单元(没看出来??);
(4)当程序有语法错误时,代码单元的展示可能并非预期结果;
(5)子函数的代码单元的定义应该在子函数之中,而非子函数的定义之前,如下图:
  如何为Matlab代码写注释? - 极夜.潜 - 极夜.潜的博客

二、为发布Matlab文档写代码注释
1、代码分单元注释与对应的Matlab发布文档展示
(1)Matlab代码:

%% Square Waves from Sine Waves% The Fourier series expansion for a square-wave is% made up of a sum of odd harmonics, as shown here% using MATLAB(R). %% Add an Odd Harmonic and Plot Itfunction fourier_demo    t = 0:.1:pi*4;    y = sin(t);    updatePlot(t,y);        %%    % In each iteration of the for loop add an odd     % harmonic to y. As _k_ increases, the output     % approximates a square wave with increasing accuracy.    for k = 3:2:9         %%        % Perform the following mathematical operation        % at each iteration:        %         % $$ y = y + \frac{sin(k*t)}{k} $$        %         y = y + sin(k*t)/k;                display(sprintf('When k = %.1f',k));        display('Then the plot is:');        updatePlot (t,y)    end    end%% Note About Gibbs Phenomenon% Even though the approximations are constantly  % improving, they will never be exact because of the % Gibbs phenomenon, or ringing.function updatePlot(t,x)% Subfunction to update the plot    cla    plot(t,x) end
(2)发布的文档:

  如何为Matlab代码写注释? - 极夜.潜 - 极夜.潜的博客
2、Matlab代码的发布方法
(1)设置:在Editor中 File --> Publish Configuration for ...
Linux中,发布的格式可选html、xml、latex、pdf。上图是以html形式发布的,公式太小(原因尚不明确),改为latex格式发布,然后生成pdf文档,则一切正常。
(2)发布:在Editor中 File --> Publish ...

3、美化发布的Matlab文档的具体手段——分节、增加公式、图片、超链接等
具体操作:在Editor中 Cell --> Insert Text Markup --> ... 

  评论这张
 
阅读(3040)| 评论(0)
推荐 转载

历史上的今天

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2018