メインコンテンツ

コードへのコメントの追加

コードを記述する際は、常にそのコードについて説明するコメントを追加することをお勧めします。コメントがあれば他者にもそのコードが理解しやすくなり、後ほどコードに立ち戻る際に思い出しやすくなります。コードの開発およびテスト中に、コメントを使用して実行する必要のないコードをコメント アウトすることもできます。

ライブ エディターでは、プロセスまたはコードを記述するコードの前後にテキスト行を挿入することができます。テキスト行によって、標準の書式設定オプションや、イメージ、ハイパーリンク、数式の挿入などの柔軟性が高まります。詳細については、ライブ エディターでライブ スクリプトを作成を参照してください。

コメントの追加

コメントを MATLAB® コードに追加するには、パーセント (%) 記号を使用します。コメント行は、コード ファイル内の任意の場所に配置できます。また、コード行の最後に付けることもできます。

以下に例を示します。

% Add up all the vector elements.
y = sum(x)           % Use the sum function.

コードのコメントアウト

コードの複数行をコメント アウトするには、ブロック コメント演算子 %{%} を使用します。%{%} の演算子は、ヘルプ テキストのブロックの直前と直後に単独で記述しなければなりません。これらの行には他のテキストは含めないでください。

以下に例を示します。

a = magic(3);
%{
sum(a)
diag(a)
sum(diag(a))
%}
sum(diag(fliplr(a)))

選択部分をコメント アウトするには、コードの対象行を選択し、[エディター] タブまたは [ライブ エディター] タブに移動し、[コード] セクションで [コメント] ボタン をクリックします。Ctrl+R キーを押すこともできます。選択した行のコードのコメントを解除するには、[コメント解除] ボタン をクリックするか、Ctrl+Shift+R キーを押します。macOS システムでは、Command+/ を使用してコメントし、Command+Option+/ を使用してコメントを解除します。Linux® システムでは、Ctrl+/ を使用してコメントし、Ctrl+Shift+/ を使用してコメントを解除します。

複数行に渡るステートメントの一部をコメント アウトするには、パーセント記号ではなく省略記号 (...) を使用します。以下に例を示します。

header = ['Last Name, ',      ...
          'First Name, ',     ...
      ... 'Middle Initial, ', ...
          'Title']

コメントの折り返し

既定の設定では、エディターおよびライブ エディターでコメントを入力する際に、列幅 75 に達するとテキストは折り返されます。次の内容を含むコメントは、エディターおよびライブ エディターで折り返されません。

  • セクション タイトル (%% で始まるコメント)

  • URL などの長い連続テキスト

  • コメントに先行する箇条書きリスト (* または # で始まるテキスト)

コメントのテキストを折り返す位置を変更したり、コメントの自動折り返しを無効にしたりするには、[ホーム] タブに移動し、[環境] セクションの [設定] をクリックします。[MATLAB][エディター/デバッガー][MATLAB 言語] を選択し、[コメント書式] 設定を調整します。

R2025a より前: 代わりに、[MATLAB][エディター/デバッガー][言語] を選択します。

現在の列幅を超える既存のコメントがある場合、コメントを自動的に折り返すには、[エディター] タブまたは [ライブ エディター] タブに移動し、[コード] セクションで [コメントを折り返す] ボタン をクリックします。たとえば、以下の長いテキストをコメント行に挿入するとします。

% This is a code file that has a comment that is a little more than 75 columns wide.
disp('Hello, world')
行の上にカーソルを置いて、[エディター] タブまたは [ライブ エディター] タブに移動し、[コード] セクションで [コメントを折り返す] ボタン をクリックします。コメントは次の行に折り返されます。
% This is a code file that has a comment that is a little more than 75
% columns wide.
disp('Hello, world')

コメントのスペルのチェック

コメントにスペルの問題がないかをチェックできます。スペル チェックを有効にするには、[ビュー] タブに移動し、[スペル] ボタンをクリックしてオンにします。スペルに問題がある可能性がある単語に青色の下線が付けられます。問題を解決するには、単語をクリックし、推奨される修正のいずれかを選択します。問題を無視するように選択したり、フラグの付いた単語をローカル辞書に追加したりすることもできます。キーボードを使用して問題間を移動するには、Alt+F7Alt+Shift+F7 を使用します。

スペル チェックは、英語 (米国) の MATLAB コード ファイルおよびライブ コード ファイル (.m および .mlx) でサポートされています。ローカル辞書から単語を削除するには、MATLAB 設定フォルダー (prefdir を実行すると返されるフォルダー) に移動し、ファイル dict/en_US_userDictionary.tdi を編集します。

参考

トピック

外部の Web サイト