ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

プログラムへのコメントの追加

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

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

メモ

プラットフォームとは異なるエンコードの文字を使用するテキストが含まれる 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+T キーを押します。

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

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

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

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

ボタンは、ライブ エディターや MATLAB Online™ では使用できません。

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

エディターは、次を含むコメントは折り返しません。

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

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

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

[コメント書式] 設定の変更は、MATLAB Online でサポートされていません。

関連するトピック