08.コメント文でメモメモ
 

プログラムコードを見ていると説明文がついているところをよく見かけます。
これはコメント文と言い、その部分はプログラムの実行には影響しません。

コメント文は「'(アポストロフィ)」から改行までの部分を指し、1行全部コメント文の時もあればプログラムに影響する部分の右に記載する場合もあります。

'変数aに5を代入
a = 5

a = 5 '変数aに5を代入

上記の文どちらもOKです。

コメントの主な使い方としては大きく2通りあります。

1つは、プログラムコードの説明です。
先頭行や各イベントの先頭辺りにプログラム名や開発日付、開発者名、おおまかな処理の説明とか書いておくと、他の人が見てもどんなプログラムなのか検討つけやすいです。
また、プログラム内の主な処理とかにも簡単な説明としてコメントをつけておくと、いちいちコードを読み解いていかなくても、ざっと流れがわかり便利です。サンプルに06章のコードにコメントをつけてみましょう。

'*****************************************************************************
'ボタンを押してダイアログ表示
'開発者:Haseta
'開発日:2006/02/19
'処理内容:
'フォーム上のボタンをマウスでクリックすると「こんにちは、花子さん」のメッセージダイアログを表示
'*****************************************************************************

Public Class Form1

 Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
   '「表示」ボタンをクリックすることでこのイベント発生。
   'メッセージダイアログを表示

  '変数の定義
   Dim namae As String '名前を格納する際に使用

   namae = "花子" '「花子」を変数namaeに代入
   MessageBox.Show("こんにちは、" & namae & "さん。") 'メッセージダイアログ表示
 End Sub
End Class

こんな感じになります。このように記載しなければならないというルールはなく、記載する人の好みにより、こと細かに説明が記述されていたり、大雑把な説明文が1行しか書いてないという場合もあります。
また、上述の通りコメント文と見なされるのはアポストロフィから改行までですから、説明文が2行以上になる場合は各行の書き始めの先頭に(1文字目という意味ではありません)アポストロフィを記述して下さい。

もう1つのコメントの使い方はコードを修正した場合に用いられます。以前に作ったプログラムをバージョンアップで変更するとか、他の人が書いたコードを修正するとかの場面でよく見られます。
こちらも必ずそうしなければならないというわけではないですが、そうした方がプログラムがより見易くなります。
こんな感じです。

  '*2006/02/19*---*Haseta*修正開始
  'namae = "花子" '「花子」を変数namaeに代入
  namae = "太郎" '「太郎」を変数namaeに代入
  '*2006/02/19*---*Haseta*修正終了

これであとから修正したことがわかりますし、元に戻したい場合も修正した部分をコメントにして、前の部分のコメントをはずせばよいのです。開発の現場では当たり前のことですので、参考にしてみて下さい。

プログラムコードは他人だけでなく自分自身がしばらく時間が経ってから見る可能性があります。その際にコメント文は非常に役立ちます。コメント文をうまく活用してわかり易いプログラムコードを書くように心がけましょう。