MATLAB中格式化M文件注释

目录

  1. 文档标题
  2. 节标题
  3. 预格式化代码
  4. 项目符号列表和编号列表
  5. 包含图片
  6. HTML代码输出
  7. LATEX代码输出
  8. TEX公式输出
  9. 强制输出
  10. 粗体、斜体和等宽字体输出
  11. 超链接

在MATLAB的M文件中,需要对格式化输出的内容进行标识。一个格式化区块开始于以下情形之一:

Cell标识行的下一行
空注释行的下一行

一个格式化区块结束以下情形之一:

Cell标识行
一个空注释行
非注释行代码

格式化输出的具体格式如下:

  1. 文档标题(回目录)
    %% 标题,双百分号后留一空格,限一行
    % 说明文字,可以多行,多行在显示时会当作一行来处理。每行文字在注释符百分号后面至少留一个空格。
    % 文档标题与节标题形式相同,但它是文档最上层的一个节。 而且,文档标题节与下一个节之间除了说明文字之外,不能有任何其他内容。
  2. 节标题(回目录)
    %% 节标题
    % 节说明文字。规则同文档标题,但节标题说明文字后可以跟源代码等其他内容。如果节标题标记出现在文档最上面,则该节后面只要跟随一些源代码,就可以成为节标题。
  3. 预格式化代码(回目录)
    % 以两个空格开头
    % 如果两个空格后还有空格,则第三个空格将作为文本输出 % 有多行预格式代码时,除了空两格的标识行外,其余行在注释符百分号后面至少留一个空格。
  4. 项目符号列表和编号列表(回目录)
    % * 空一格后加一个星号*或#号
    % * *号或#号后面至少留一个空格,多于一个空格时将视为一个空格。
    % 如果同一个列表项目有多行,则第二行开始不加*号或#号,注释百分号后面加一个空后接续内容。
  5. 包含图片(回目录)

    以一个空行开头,最后以一个空行结束。

    % <<filepath/image.jpg>>
  6. HTML代码输出(回目录)
    % <html>
    % <table border="1"><tr><td>内容</td></tr></table>
    % </html>
  7. LATEX代码输出(回目录)
    % <latex>
    % $f(x)$
    % </latex>
  8. TEX公式输出(回目录)
    $$ f(x)=y^2 $$
  9. 强制输出(回目录)
    for i=1:3
    imagesc(magic(i))
    snapnow;
    end
  10. 粗体、斜体和等宽字体输出(回目录)
    % *粗体*
    % _斜体_
    % |等宽字体|
  11. 超链接(回目录)
    % <http://www.163.com>
    % <http://www.163.com 网易>
原文地址:https://www.cnblogs.com/jyginger/p/1807383.html