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

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

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

メモ

プラットフォームとは異なるエンコードの文字を使用するテキストが含まれる MATLAB^® コードファイル (.m) を保存またはパブリッシュすると、MATLAB ではそれらの文字が文字化けして表示されます。ライブスクリプトおよびライブ関数 (.mlx) は、すべてのロケールの文字の保存と表示をサポートします。

コメントを 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']

エディターおよびライブエディターには、MATLAB、Java^® および C/C++ コードにコメントの追加、削除、書式変更ができるツールおよびコンテキストメニュー項目が含まれています。たとえば、以下の長いテキストをコメント行に挿入するとします。

% 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')

既定の設定では、エディターおよびライブエディターでコメントを入力する際に、列幅 75 に達するとテキストは折り返されます。コメントのテキストを折り返す列を変更したり、コメントの自動折り返しを無効にしたりするには、[ホーム] タブに移動し、[環境] セクションの [基本設定] をクリックします。[MATLAB] 、 [エディター/デバッガー] 、 [言語] を選択し、[コメント書式] 基本設定を調整します。MATLAB Online™ で [コメント書式] 基本設定を調整するには、[エディター/デバッガー] 、 [MATLAB 言語] を選択します。

次の内容を含むコメントは、エディターおよびライブエディターで折り返されません。

セクションタイトル (%% で始まるコメント)
URL などの長い連続テキスト
コメントに先行する箇条書きリスト (* または # で始まるテキスト)

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

関連するトピック