ドキュメンテーション

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

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

コードを記述する際は、常にそのコードについて説明するコメントを追加することをお勧めします。コメントがあれば他者にもそのコードが理解しやすくなり、後ほどコードに立ち戻る際に思い出しやすくなります。

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

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

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

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

実行する必要のないコードをコメント アウトできるので、コメントはプログラムの開発とテストにおいても便利です。コードの複数行をコメント アウトするには、ブロック コメント演算子 %{%} を使用します。

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

%{%} の演算子は、ヘルプ テキストのブロックの直前と直後に単独で記述しなければなりません。これらの行には他のテキストは含めないでください。

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

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

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

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

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

  • URL などの長い連続した文字列

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

設定の変更はライブ スクリプトでは適用されません。

関連する例

詳細

この情報は役に立ちましたか?