MATLAB 程式設計/註釋

放置註釋

註釋行以字元 '%' 開頭， '%' 字元後的任何內容都會被直譯器忽略。 '%' 字元本身只告訴直譯器忽略同一行的其餘部分。

在 MATLAB 編輯器中，註釋區域預設以綠色顯示，因此應該很容易識別。有兩種有用的鍵盤快捷鍵可用於新增和刪除註釋塊。選擇要註釋或取消註釋的程式碼，然後按 Ctrl-R (⌘-/ for Mac) 在每行開頭放置一個 '%' 符號，按 Ctrl-T (⌘-T for Mac) 執行相反的操作。

MATLAB 還支援多行註釋，類似於 C 或 C++ 中的 /* ... */，透過 %{ 和 %} 定界符。但有一個細微但重要的區別。在 MATLAB 中，不允許以 %{ 或 %} 開頭的行包含任何其他文字（空格除外）。否則它將無法正常工作。例如：

%{ for i = 1:10
  disp(i)
end %}

會報錯，但是

%{
for i = 1:10
  disp(i)
end
%}

可以正常工作。

常用用法

註釋對於解釋特定程式碼段的功能很有用，尤其是在程式碼依賴於隱式或微妙的假設或以其他方式執行微妙操作時。這樣做對你自己和其他人閱讀你的程式碼都是個好主意。例如：

% Calculate average velocity, assuming acceleration is constant
% and a frictionless environment.
force = mass * acceleration

通常建議將解釋 M 檔案功能以及如何使用它的註釋塊作為第一行文字。當你輸入時，MATLAB 會輸出函式定義之前的註釋或函式定義內第一個註釋塊之前的註釋

>> help functionname

所有用 MATLAB 編寫的 MATLAB 自身函式也以這種方式記錄。

註釋還可以用於標識作者、參考資料、許可證等等。這樣的文字通常位於 M 檔案的末尾，但也可能位於開頭。最後，註釋可以用來幫助除錯，如 除錯 M 檔案 中所述。