VBScriptでコメントアウトするには

2024.07.03

コメント化（コメントアウト）はプログラミングにおいて非常に重要なスキルです。

VBScriptではコメントを使うことで、コードの理解を助けたり、デバッグを効率的に行ったりすることができます。

この記事では、VBScriptでコメントを使いこなすための方法を詳しく解説します。

コメントアウトとは？

コメントアウトの目的

コメントアウトとは、プログラムの実行に影響を与えない説明文やメモを書き込む機能のことです。

  • コードの理解を助ける: 他のプログラマーや自分自身が後でコードを見返したとき、どのような意図で記述されたかを把握しやすくなります。
  • デバッグの補助: 実行時に問題が発生した際、特定の部分だけを無効にして原因を特定する際に役立ちます。
  • ドキュメント代わり: プログラムの使い方や仕様を簡単なメモとして残すことができます。

コメントアウトの使い方

コメントアウトされた部分は、プログラムの実行時に無視されます。

従って、プログラムのロジックには全く影響しません。正しく使えば、コードの保守性が大幅に向上し、他の開発者との協力もしやすくなります。

VBScriptにおけるコメントアウトの基本

VBScriptでは、コメントアウトを行う方法は非常にシンプルです。以下の2つの方法があります。

シングルクォート（’）を使う方法

VBScriptでは、行の先頭または任意の位置にシングルクォート（アポストロフィ）を記述することで、その行以降がコメントとして扱われます。

' この行はコメントです。
Dim message
message = "こんにちは、VBScript！"  ' ここもコメントとして無視されます。

上記の例では、最初の行全体と、変数の代入行の後半部分がコメントとなり、実行時に影響を与えません。シングルクォートを使う方法は最も一般的で、初心者でも覚えやすい方法です。

Rem キーワードを使う方法

もうひとつの方法として、Rem キーワードを使う方法があります。Rem の後にスペースを入れると、続く文字列は全てコメントとして扱われます。

Rem この行はコメントです。
Dim greeting
greeting = "Hello, World!"  Rem この部分はコメントです。

Rem は、古いBASIC系言語から引き継がれた形式ですが、VBScriptでも利用可能です。ただし、シングルクォートの方がシンプルで直感的なため、現在ではほとんどの場合シングルクォートが用いられています。

コメントアウトの効果的な活用方法

コードの意図を説明

コメントは「何をしているか」だけでなく、「なぜそれをしているか」を説明するのに使います。

また、プログラムを書くときに自分が何を意図しているかを後で振り返るため、またはチームメンバーに伝えるために、重要な部分にコメントを残すと良いでしょう。

' ユーザー名を取得して表示
Dim userName
userName = InputBox("Enter your name:")
' ユーザー名が空でない場合のみメッセージを表示
If userName <> "" Then
    MsgBox "Hello, " & userName
End If

変更履歴を記録

コメントを使って、コードの変更履歴や理由を記録します。

' 2024-06-01: 初期バージョン作成
' 2024-06-02: ユーザー名の空チェックを追加

デバッグのための一時的なコードの無効化

開発中にプログラムが予期しない動作をする場合、特定の部分だけを一時的に無効化して原因を特定する方法としてコメントアウトを利用します。たとえば、以下のようなコードがあったとします。

Dim a, b, result
a = 10
b = 0
' result = a / b  ' ゼロ除算エラーになるため、一時的にコメントアウト
MsgBox "計算結果は: " & a  ' コメントアウト解除後、別の処理に切り替え可能

ここでは、ゼロ除算によるエラーが発生する部分をコメントアウトすることで、プログラム全体の動作確認を行いやすくしています。

複数行コメント

VBScriptでは複数行のコメントを直接サポートしていませんが、各行にシングルクォートを追加することで複数行のコメントを実現できます。

' 複数行コメントの例
' このスクリプトは
' ユーザー入力を処理します
Dim userInput
userInput = InputBox("Enter your name:")

コメントアウトにおける注意点

コメントとコードの整合性

コメントはあくまで説明文であり、コードそのものではありません。そのため、コードを修正した際にはコメントも合わせて更新することが大切です。

古いコメントが残っていると、後でコードを読む人が混乱する可能性があります。

過剰なコメントを避ける

コメントは有益であるべきです。

開発初期は、試行錯誤のために多数のコメントを残しがちですが、最終的には本当に必要な説明だけを残し、不要なコメントは削除するようにしましょう。

過剰なコメントはコードの見通しを悪くする原因となります。

Dim a ' 変数aを宣言
a = 5 ' 変数aに5を代入

セキュリティ上の注意

コメントには、システムの動作や変数の中身、エラー処理の内容などが記載されることがあります。これらの情報が外部に漏れると、セキュリティリスクが高まる可能性があるため、公開するコードの場合は注意が必要です。

特に、パスワードやシークレットキーなどの情報はコメントに含めないようにしましょう。

演習問題

最後に以下の演習問題を通して、VBScriptでのコメントの使い方を練習してみましょう。

演習1

次のコードを見て、適切な場所にコメントを追加してください。

Set objFSO = CreateObject("Scripting.FileSystemObject")
Set objFile = objFSO.OpenTextFile("example.txt", 1)

Do Until objFile.AtEndOfStream
    strLine = objFile.ReadLine
    WScript.Echo strLine
Loop

objFile.Close
演習1 解答例 
' ファイルシステムオブジェクトを作成
Set objFSO = CreateObject("Scripting.FileSystemObject")

' テキストファイルを開く（読み取り専用）
Set objFile = objFSO.OpenTextFile("example.txt", 1)

' ファイルの終わりまで各行を読み取って表示
Do Until objFile.AtEndOfStream
    strLine = objFile.ReadLine
    WScript.Echo strLine
Loop

' ファイルを閉じる
objFile.Close

演習2

次のコードで、Rem キーワードを使ってマルチラインコメントを追加してください。

WScript.Echo "Starting the script..."
' ここでスクリプトのメイン処理が行われます
WScript.Echo "Script completed."
演習2 解答例 
WScript.Echo "Starting the script..."

Rem このスクリプトは単純なメッセージを表示します。
Rem スクリプトの主な目的は、WScript.Echoメソッドを使ったメッセージ表示のデモです。

WScript.Echo "Script completed."

まとめ

VBScriptでコメントアウトを効果的に使うことで、コードの可読性が向上し、メンテナンスが容易になります。

コメントの基本的な使い方から、ベストプラクティスまでをマスターし、他の開発者や将来の自分にとって有用なコードを書く習慣を身につけましょう。