12.1 M文件的注釋
使用%進行注釋。
連續多行注釋Ctrl+R,取消注釋Ctrl+T。
12.2 Cell模式
在MATLAB腳本文件中使用連續兩個注釋符,開啟一個新的Cell塊,%%后空一格追加注釋語句,所在行以粗體字顯示。當前選中的Cell區域以淡橙色背景展示。
單擊運行節(Ctrl+Alt+Enter)可以單獨運行某一個Cell,方便調試。
12.3 注釋的Publish
doc step
其實MATLAB的help文檔就是從代碼中產生的,只不過不是一般的代碼,而是純注釋。
注釋生成文檔源自MATLAB的Publish功能,可將注釋文件生成.doc、.html等常用格式文件。當我們將注釋按照一定的規則書寫的時候,就可以自動生成所期望的漂亮規范的文本。
12.3.1 正文
>> publish('example') ans = 'C:\Users\lenovo\Desktop\html\example.html'
12.3.2 字體控制
在正文兩端增加'_'或'*'符號,可以得到斜體字和粗體字效果。
12.3.3 小標題
在%注釋后加*符號和空格,生成點開頭的標題;在%注釋后加#符號和空格,生成數字序號列表。單獨的%行會打斷數字的連續性。
12.3.4 插入超鏈接
將網址用< >括住,在網址后空一格輸入希望顯示的文字。
12.3.5 插入可執行代碼
% Please press <MATLAB:run('example.m') Run example code> to run % the m script demo file. a = 1; b = 2;
在MATLAB中打開后,單擊鏈接即可執行腳本內容。
%% Publish codes with execution results. for i=1:4 imagesc(rand(6,6)); snapnow; end % run open(publish('chap12_03_11.m')) in Command window.
發布
12.4 注釋發布功能的應用場景
注釋發布的功能不僅支持html類型,Doc、PPT等也都在Publish支持范圍內。