エクセルVBA｜コメントアウトを一括でまとめて設定・解除する方法

エクセルVBAに限らず、プログラミングをする人にとって一部のコードを実行しないようにすることをコメントアウトと言います。VBAでは、文頭に(‘)シングルクォーテーションを書くことで対象の行をVBAのプログラムコードではなく、プログラムとして読み取られないようにコメントとして残すことができます。

この記事では、VBAのコードを書く開発環境であるVBEで特定の行をコメントアウトする方法と、複数行を一括でまとめてコメントアウトを設定・解除する方法を紹介します。効果的なコメントアウトを行うことで、後でコードを見返したときや、第三者からコードの読みやすさが向上することなどのメリットがあります。

エクセルVBAでコメントアウトをする目的について

プログラミングをコメントアウトをする目的としては以下のようなものがあります。

• コメントアウトの付近に書いたプログラムコードの説明やメモを書く
• コードのテストやデバッグを行う
• プログラムコードを一時的に無効化や保留をする

エクセルVBAでコメントアウトをするメリットについて

プログラミングをコメントアウトをする効果としては以下のようなものがあります。

• コードの可読性や理解度を高める
• コードのエラーやバグを防ぐ
• コードの改良や修正を容易にする

VBE画面でコメントアウトを設定・解除する方法

VBE画面でVBAのコードをコメントアウトするときに、指定の行のみをコメントアウトする方法と複数行を一括して設定・解除する方法をそれぞれ紹介します。

なお、複数行のコメントアウトを一括して実行するには、事前にアイコンを表示しておくと便利ですので、VBE画面でコメントブロックアイコンや非コメントブロックアイコンが表示されているかご確認ください。

アイコン画像や表示方法は次で紹介していきます。

VBEを起動する方法は以下の記事を参考にしてください。

VBE画面にコメントアウトの設定アイコン・解除アイコンを表示する

VBAでコメントをする方法は大きく分けて2つあります。
それぞれ行でコメントアウトを設定する場合、コメントアウトしたい行の文頭に(‘)シングルクォーテーションを書くことでコメントが可能です。また、コメントアウトを解除する場合は、文頭の(‘)シングルクォーテーションを削除すれば非コメントアウト状態に戻すことができます。

続いて、複数行を一括してコメントアウトする方法ですが、VBE画面にてツールバーの[編集]メニューが表示されている場合は、コメントブロックと非コメントブロックのアイコンをクリックすることでコメントアウトの設定と解除が実行できます。

設定方法は簡単で、コメントアウトしたい行をマウスやキーボードでまとめて選択して、コメントブロックアイコンをクリックすると選択範囲がコメントブロックされます。また、同じ手順で非コメントブロックアイコンをクリックするとコメントアウトが解除されます。

VBEの画面上にツールバーの[編集]メニューが表示されていないときは

VBEの画面上にツールバーの[編集]メニューが表示されていない場合は、画面上の[表示]から[ツールバー]を選択して、[編集]にチェックをつけた状態にするとメニューが表示されます。

VBAコードでコメントアウトを一括で設定・解除する方法

複数行を選択してコメントアウトを設定・解除する方法ですが、こちらで掲載している動画の手順で設定が可能です。

コメントアウトした結果がわかるように、以下のサンプルコードを使って確認してみます。

サンプルマクロのVBAコード

  Copy
Option Explicit

Sub CommentOut()

    Dim mojiretu As String
    
    mojiretu = "おはよう！"
    
    Debug.Print mojiretu

    mojiretu = "こんにちは！"

    Debug.Print mojiretu

    mojiretu = "こんばんは！"

    Debug.Print mojiretu

    mojiretu = "おやすみ！"

    Debug.Print mojiretu

    mojiretu = "お疲れ様でした！"

    Debug.Print mojiretu

End Sub

変数mojiretuを宣言して、文字列を変数に代入後にデバッグプリントで表示する。改めて別の文字列を代入してデバッグプリントで表示する。をくり返すだけのシンプルなマクロです。

05行目

文字列型の変数mojiretuを宣言します。

07行目

変数mojiretuに”おはよう“の文字列を代入します。

09行目

デバッグプリントでmojiretuに代入された値をイミディエイトウィンドウに表示します。

11行目

変数mojiretuの”おはよう”を”こんにちは！“で上書きします。

13行目

デバッグプリントでmojiretuに代入された値をイミディエイトウィンドウに表示します。

15行目

変数mojiretuの”こんにちは！”を”こんばんは！“で上書きします。

17行目

デバッグプリントでmojiretuに代入された値をイミディエイトウィンドウに表示します。

19行目

変数mojiretuの”こんばんは！”を”おやすみ！“で上書きします。

21行目

デバッグプリントでmojiretuに代入された値をイミディエイトウィンドウに表示します。

23行目

変数mojiretuの”おやすみ！”を”お疲れ様でした！“で上書きします。

25行目

デバッグプリントでmojiretuに代入された値をイミディエイトウィンドウに表示します。

実行結果(イミディエイトウィンドウ)

変数mojiretuに代入された文字列(あいさつ文)を順番に表示しています。

VBAコードをコメントアウトを一括で設定する(コメントブロック)

ツールバーの[編集]から以下のコメントブロックアイコンをクリックしてください。

コメントブロックアイコンをクリックして、選択した範囲をコメントアウトします。その後、マクロを実行するとコメントアウトした部分はマクロとして実行されなくなるため、イミディエイトウィンドウには”おはよう！”のみを表示します。

実行結果(イミディエイトウィンドウ)

VBAコードをコメントアウトを一括で解除する(非コメントブロック)

ツールバーの[編集]から以下の非コメントブロックアイコンをクリックしてください。

非コメントブロックアイコンをクリックして、コメントアウトを解除します。その後、マクロを実行しています。イミディエイトウィンドウに表示される結果がコメントアウトをする前の状態に戻ります。

コメントアウトの一括設定・解除をさらに手軽にする方法として、ショートカットキーに登録する方法があります。ショートカットキーへの登録方法は本記事のさいごで紹介しています。

VBAコードでコメントアウトを個別の行で設定・解除する方法

複数行を指定する手順もあれば、それぞれの行に対してコメントアウトを設定・解除する方法もあります。方法はコメントアウトしたい行の文頭に(‘)シングルクォーテーションを書くだけです。

サンプルコードをつかって指定の行をコメントアウトしてマクロを実行してみます。

サンプルマクロのVBAコード

  Copy
Option Explicit

Sub CommentOut()

    Dim mojiretu As String
    
    mojiretu = "おはよう！"
    
    Debug.Print mojiretu

    'mojiretu = "こんにちは！"

    Debug.Print mojiretu

    mojiretu = "こんばんは！"

    Debug.Print mojiretu

    mojiretu = "おやすみ！"

    Debug.Print mojiretu

    mojiretu = "お疲れ様でした！"

    Debug.Print mojiretu

End Sub

11行目のコードをコメントアウトするため、行の文頭に(‘)シングルクォーテーションを書きました。(‘)シングルクォーテーションはShiftキーを押しながら、7キーを押すことで入力できます。

この状態でサンプルマクロを実行した結果を見てみましょう。

11行目の[mojiretu = “こんにちは！”]がコメントアウトされたことで、プログラムのコードとして実行されなくなり変数mojiretuの値は”おはよう”のままとなります。

そのため、おはよう！が2回表示される実行結果になりました。

ショートカットキーでコメントアウトを一括設定・解除する方法

ここまでで個別に指定した行と、複数行のコメントアウトを一括で設定・解除する方法を紹介してきました。つぎにコメントアウトをさらに簡単にするための方法として、ショートカットキーで利用する方法を紹介します。

プログラムをコーディングをする上で、コメントアウトをする操作を少しでも簡単にしたい人はこちらの方法で、ショートカットキーにコメントアウト機能を登録することをおすすめします。

コメントブロック・非コメントブロックをショートカットキーに登録する

ここからはコメントブロックと非コメントブロックをそれぞれショートカットキーに登録していきますが、それぞれのショートカットキーは以下のようにします。

ショートカットキー	機能(機能概要)
Alt + /	コメントブロック(コメントアウトを設定する)
Alt + ¥	非コメントブロック(コメントアウトを解除する)

ショートカットキーの登録手順

まずは、VBEの上部で右クリックをし、ユーザー設定をクリックします。

つづいて、ユーザー設定のメニューにてコマンドタブを選択した状態にします。その状態のまま画面上部にあるツールバーのコメントブロックアイコンまたは、非コメントブロックアイコンをクリックします。

ユーザー設定メニュー内の[選択したボタンの編集]がクリックできるようになります。

[選択したボタンの編集]をクリックすると表示されるリストメニューで[名前]の右側にある入力欄があります。初期値だと”コメントブロック”などが表示されていますが、削除して(&/)を入力します。

さらに、[イメージとテキストを表示]の左側に✅をつけます。

すべての設定が完了したら、ツールバーのコメントブロックアイコンと非コメントアイコンの右側に以下の画像のように表示されます。

この状態になればショートカットキーの登録は完了しています。

あとは、VBEのコード入力画面でコメントアウトの設定・解除したい箇所を選択して、ショートカットキーに指定した、Alt + / または Alt + ¥の操作をすれば、コメントアウトの設定・解除が実行されます。

コメントアウトを一括でまとめて設定・解除する方法まとめ

この記事では、VBAのプログラムコードを書くときにコメントアウトする方法を解説しました。

コメントアウトは、プログラムやマクロを作るときに残しておくことで、コードの修正やアップデートが発生したときに重要な手がかりとして残せます。なぜなら、適切なコメントアウトが残せるようになれば、プログラムやマクロの全容の理解がとてもスムーズになり、それらの理解がしやすいと言うことは修正や改良をしやすいものにするからです。

さいごにこれまで解説した内容をまとめておきます。

コメントアウトをする目的

• 付近のプログラムコードを説明・解説メモを残す
• プログラムをテストする際に一時的に無効化したり保留するためにつかう

コメントアウトをしたときのメリット

• コードの可読性があがり理解がしやすくなる
• コードのエラーやバグを予防する
• コードの修正や改良をしやすくする

コメントアウトをする手順

• 1行だけコメントアウトするときは、行の先頭にシングルクォーテーションを書く
• まとめてコメントアウトの設定・解除をするときは、コメントブロックアイコン・非アイコンを利用する
• さらに便利で簡単に使うには、ショートカットに登録する方法もある

今回はここまで。