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

2024.07.03

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

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

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

コメントの基本

コメントは、vbsファイル内に記述された無効化されたプログラムのことです。

VBScriptでコメントを挿入するには、「'（シングルクォート）」または「REM + 半角スペース」を使用します。

一般的にシングルクォートの方が使用されるため、シングルクォートを用いて解説していきます。

シングルクォートの後に続くすべての文字はコメントとして扱われ、スクリプトの実行には影響しません。

'これはコメントです
REM これもコメントです
Dim x
x = 10 ' この行の最後もコメントにできます

コメントの使い方

説明の追加

コメントを使ってコードの目的や動作を説明します。

これにより、他の開発者や将来の自分がコードを理解しやすくなります。

'xに10を代入
Dim x
x = 10

一時的なコードの無効化

コードの一部を一時的に無効化するためにコメントを使います。

これはデバッグ時に便利です。

'y = 20
Dim z
z = 30

複数行コメント

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

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

コメントのベストプラクティス

コードの意図を説明

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

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

変更履歴を記録

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

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

過剰なコメントを避ける

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

明白なコードにはコメントを追加しないようにしましょう。

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

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