zoukankan      html  css  js  c++  java
  • Matlab 代码注释

    Matlab 代码注释

    一直在找类似doxygen一样将程序注释发表成手册的方法,现在发现,Matlab的publish功能自己就能做到。

    Publish 简介

    并非所有注释都能作为文本进行输出,MATLAB 的 publish 要求内容中必须包含段落标题,即双百分号注释%%。且注释内容与行首%号之间也必须有空格,才能让注释内容正确显示。

    而且与doxygen不同的是,Matlab publish需要像调用函数一样输入参数,而函数运行结果也可以同内容一齐打印出来。

    Publish 输出格式

    Publish 文本格式与 Markdown 格式类似,主要的几种文本格式有:

    输出格式 示例
    段落标题 %% SECTION TITLE
    文字格式 % _斜体_ % *加粗*
    编号 % * 加点编号 % # 数字编号
    代码 % 三个空格
    LaTeX 公式 % $内嵌公式$ % $$ 块公式 $$

    此外,还包含了几种特殊的图片和超链接文本格式:

    输出格式 示例
    图片 % <<filename.png>>
    超链接 % <http://www.google.com.hk>
    运行matlab指令超链接 % <matlab:syntax text>

    有关matlab指令超链接的例子

    %% Recycling Preference
    % Click the preference you want:
    %
    % <matlab:recycle('off') Disable recycling>
    %
    % <matlab:recycle('on') Enable recycling>
    

    还有

    %%
    % See the 
    % <matlab:edit(fullfile(matlabroot,'toolbox','matlab','codetools','publish.m')) code> 
    % for the publish function.
    

    前者在文本 Disable recyclingEnable recycling 处建立超链接,当点击此链接时运行 recycle('off')recycle('on') 命令;后者运行 edit 命令,打开.m文件。

  • 相关阅读:
    Struts2-result配置结果视图
    Struts2 -action处理业务请求
    struts 2
    mvc模式
    vue之webpack安装配置vue
    vue之webpack
    文件上传
    LinkedList详解
    ArrayList详解
    HashMap详解
  • 原文地址:https://www.cnblogs.com/li12242/p/5617346.html
Copyright © 2011-2022 走看看