コメントの書き方

このレッスンでは、VB.NETでコメントを書く方法を学び、コードの意図を人にも自分にも伝わりやすくすることを目標にします。「VB.NET コメント 書き方」で調べている方向けです。

'を使うと、その行はコメントとしてプログラムの実行に影響しなくなります。コメントは実行されない、人間のための説明書きです。処理の意図や理由をコードに残しておく役割を持ちます。

サンプルコードでは、' これは1行コメントですのように行全体をコメントにする書き方と、Dim price As Integer = 100 ' 商品の価格(円)のようにコードの末尾に説明を added する書き方の両方を確認できます。

初心者がよくつまずくのが、コメントを書きすぎて逆に読みにくくなることです。「何をしているか」ではなく「なぜそうしているか」を書くのがよいコメントのコツで、コードを見れば分かることまで書く必要はありません。

実際の開発現場では、チームで開発する際にコメントが意図を共有する重要な手段になります。半年後の自分が読んでも分かるように書いておくと、後々の修正や引き継ぎがスムーズになります。