VB.NETでは、コード内にコメントをつけることで、コードの意図や補足情報を記述することができます。
ここでは、VB.NETでコメントを書く基本や複数行に渡るコメントについて解説します。
VB.NETのコードの中でコメントを書くには?
VB.NETでは、コメントを書く際に行の先頭にアポストロフィ('
)を使用します。
これにより、コードの説明やメモを残すことができ、コンパイル時に無視されます。
Dim x As Integer = 10 ' xに10を代入する
通常、上記のような簡単な処理にはコメントは残さずに
わかりにくい処理など、後で見て忘れそうな箇所にコメントを残します。
VB.NETでコードのコメントアウトとは?
コメントアウトとは、コードを一時的に無効化することを指します。
コードの先頭に'
を追加すると、その行は実行されずに無視されるようになります。
現在は使わないけど、将来的に使うようなコードを残したり、デバッグ時に一時的に無効にする時に有効です。
'Dim y As Integer = 20 ' このコードは無効化されています
VB.NETで複数行コメントをすることができる?
VB.NETには、C#のような/* ... */
による複数行コメントの構文はありません。
そのため、複数行のコメントが必要な場合、各行に'
を付ける必要があります。
' ここから複数行コメント
' このコードは一時的に無効です
' 将来的に使用する可能性があります
終わりに
VB.NETでコメントを書く方法について紹介しました。
コードを書いていて、そのときは覚えていても、3ヶ月後などに見ると処理がすぐに理解できないものです。
後からコードを確認する人や、数ヶ月後にコードを確認する自分に配慮し
関数のヘッダコメントや、複雑な処理にはコメントを残して、理解できるようにしておきましょう。
コメント