プログラムの注釈 : コメントを使用する

更新 : 2007 年 11 月

このレッスンでは、プログラムのコード内にコメントを作成する方法を説明します。

プログラムを構成するコードは、読んで理解するのが難しいことがあります。自分で記述したコードでない場合には特にそうです。コメントを使用すると、自分自身、またはコードを使用する他の人を対象に、メモを作成できます。

コメントは、コード エディタで入力されたテキストですが、プログラムの実行時には Visual Basic コンパイラによって無視されます。このため、プログラムの特定のセクションが果たす役割を説明したり、完了していないプログラミング タスクの実行を促したりするために、自分自身に対してメモを記述できます。

コメントを作成するには、行の先頭に ' 文字を入力します。コメントの作成方法を次の例に示します。

' This is a comment. WOW!

同様に ' 文字を使用して、コメントを行末に追加することもできます。この方法は、各コード行に関するコメントを付加する場合によく使用されます。次に例を示します。

MsgBox("Hello World!") ' This line causes a message box to appear.

単一行コメントと同様、行内で ' 文字の後に続くすべてのテキストは、プログラムによって無視されます。

デバッグのためにコメントを使用する

コメントのもう 1 つの一般的な用途は、プログラムのデバッグ時に、一時的にコード行が実行されないようにすることです。たとえば、メッセージ ボックスを表示する次のようなコード行があるとします。

MsgBox("Hello World!")

メッセージ ボックスを表示せずにプログラムを実行するが、メッセージ ボックスを完全に削除しない場合は、次に示すようにコメント文字 (') を使用して、メッセージ ボックスを一時的にプログラムから隠すことができます。

' MsgBox("Hello World!")

' 文字の後にあるすべてのテキストは無視されるため、プログラムはこの行を飛ばして実行されます。後で ' 文字を削除すると、メッセージ ボックスが表示されるようになります。

やってみよう

コメントを挿入するには

  1. [ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。

  2. [新しいプロジェクト] ダイアログ ボックスの [テンプレート] ペインで、[Windows アプリケーション] をクリックします。

  3. [プロジェクト名] ボックスに「Comments」と入力し、[OK] をクリックします。

    新しい Windows フォーム プロジェクトが開きます。

  4. フォームをダブルクリックしてコード エディタを開きます。

  5. Form1_Load イベント ハンドラに次のコードを追加します。

    ' This code will cause two message boxes to appear
    MsgBox("This is Message Box 1") ' Display Message Box 1
    MsgBox("This is Message Box 2") ' Display Message Box 2
    
  6. F5 キーを押してプログラムを実行します。

    プログラムが起動し、2 つのメッセージ ボックスが順に表示されます。

  7. [デバッグ] メニューの [デバッグの停止] をクリックしてプログラムを終了します。

  8. コード エディタで、1 つ目のメッセージ ボックスの行に、コメント文字 (') を次のように追加します。

    ' MsgBox("This is MessageBox 1") ' Ignore Message Box 1
    
  9. F5 キーを押してプログラムを実行します。

    今度は、1 つ目のメッセージ ボックスの行が無視され、2 つ目のメッセージ ボックスのみが表示されます。

次の手順

このレッスンでは、コード内にコメントを作成する方法と、各コード行を一時的に無効にする方法を説明しました。これで、デバッグに関するレッスンは終了です。次からのレッスンでは、データベースを使用してプログラムの情報を格納および取得する方法を説明します。

次のレッスン : 「レコードの管理 : プログラムでデータを使用する

参照

概念

コード内のコメント

その他の技術情報

問題の確認 : デバッグを行ってエラーを検出し、修正する