もうVBEは卒業！VSCodeで快適なVBA開発環境を作る

By /

もうVBEは卒業！VSCodeで快適なVBA開発環境を作る

長年、VBA開発といえばVBE (Visual Basic Editor) が標準でした。しかし、VBEはその機能の古さから、現代の開発環境と比較すると多くの点で不便を感じることがあります。コード補完の弱さ、デバッグ機能の制限、バージョン管理の難しさなど、開発効率を阻害する要因は少なくありません。

そこで今、注目されているのがVisual Studio Code (VSCode) を利用したVBA開発環境です。VSCodeは、マイクロソフトが開発した無料のオープンソースエディタであり、豊富な拡張機能と高いカスタマイズ性が特徴です。これらを活用することで、VBEでは実現できなかった快適なVBA開発環境を構築することができます。

本記事では、VSCodeを使ってVBA開発環境を構築し、VBEを卒業するための具体的な手順と、VSCodeならではのメリットを余すことなく解説します。

目次

  1. VBEの限界とVSCodeの可能性
    • VBEの現状と課題
    • VSCodeがVBA開発にもたらすメリット
  2. VSCodeでVBA開発環境を構築する
    • VSCodeのインストール
    • VBA拡張機能の導入
    • 設定ファイルの作成と編集
  3. 必須の拡張機能で開発効率を爆上げ
    • VBA (Visual Basic for Applications)
    • Excel-VBA-Formatter
    • Code Spell Checker
    • その他おすすめ拡張機能
  4. VSCodeでVBA開発を実践する
    • 新規VBAプロジェクトの作成
    • コードの記述と実行
    • デバッグ機能の活用
    • ブレークポイントの設定とステップ実行
    • イミディエイトウィンドウの利用
  5. Git連携でバージョン管理を強化する
    • Gitのインストールと初期設定
    • リポジトリの作成とコミット
    • ブランチの活用とマージ
  6. さらなる効率化！便利な設定とテクニック
    • スニペットの活用
    • キーボードショートカットのカスタマイズ
    • タスクランナーの活用
  7. トラブルシューティングとQ&A
    • よくある問題と解決策
    • 読者からの質問と回答
  8. まとめ: VSCodeでVBA開発の未来を切り開く

1. VBEの限界とVSCodeの可能性

1.1 VBEの現状と課題

長年VBA開発の中心だったVBEですが、現代の開発環境と比較すると、以下のような課題が挙げられます。

  • コード補完の弱さ: コード補完の精度が低く、候補が少ないため、タイピングの手間が増える。
  • デバッグ機能の制限: デバッグ機能が限定的で、複雑な処理のデバッグに時間がかかる。ウォッチ式の柔軟性も低い。
  • バージョン管理の難しさ: VBAファイルはテキスト形式ではないため、Gitなどのバージョン管理システムとの連携が困難。
  • UI/UXの古さ: 全体的にUI/UXが古く、操作性が悪い。モダンなエディタと比較すると見劣りする。
  • 拡張性の低さ: 拡張機能がほとんどなく、カスタマイズ性が低い。

これらの課題は、開発効率を著しく低下させ、大規模なプロジェクトや複数人での開発を困難にする要因となります。

1.2 VSCodeがVBA開発にもたらすメリット

VSCodeは、VBEの課題を克服し、VBA開発をより快適にするための多くのメリットを提供します。

  • 強力なコード補完: IntelliSenseによる高度なコード補完により、入力ミスを減らし、開発速度を向上させます。メソッド名やプロパティ名だけでなく、引数のヒントも表示されます。
  • 充実したデバッグ機能: ブレークポイントの設定、ステップ実行、ウォッチ式の利用など、VBEよりも強力なデバッグ機能を利用できます。これにより、複雑な処理も効率的にデバッグできます。
  • Git連携によるバージョン管理: Gitとの連携が容易であり、コードの変更履歴を管理し、複数人での共同開発を円滑に進めることができます。
  • 豊富な拡張機能によるカスタマイズ: さまざまな拡張機能を導入することで、VBA開発環境を自分好みにカスタマイズできます。コード整形、スペルチェック、テストなど、さまざまなツールを統合できます。
  • モダンなUI/UX: シンプルで洗練されたUI/UXにより、快適な開発体験を提供します。ダークテーマなど、好みに合わせたテーマを選ぶこともできます。
  • クロスプラットフォーム対応: Windows、macOS、Linuxなど、さまざまなOSで利用できます。
  • 無料で利用可能: オープンソースのエディタであり、無料で利用できます。

これらのメリットにより、VSCodeはVBA開発を大幅に効率化し、より高品質なコードを作成するのに役立ちます。

2. VSCodeでVBA開発環境を構築する

2.1 VSCodeのインストール

まずはVSCodeをインストールします。公式サイト (https://code.visualstudio.com/) から、自分のOSに合ったインストーラをダウンロードして実行してください。

インストール時に特に注意する点はありませんが、「PATHへの追加」オプションはチェックしておくことをおすすめします。これにより、コマンドプロンプトやターミナルからcodeコマンドでVSCodeを起動できるようになります。

2.2 VBA拡張機能の導入

VSCodeを起動したら、VBA開発に必要な拡張機能をインストールします。

  1. 拡張機能ビューを開く: VSCodeの左側にあるアクティビティバーから、拡張機能アイコン（四角いブロックが並んだアイコン）をクリックします。
  2. 拡張機能を検索する: 検索ボックスに「VBA」と入力し、VBA関連の拡張機能を検索します。
  3. 拡張機能をインストールする: おすすめの拡張機能については後述しますが、まずは「VBA (Visual Basic for Applications)」という拡張機能をインストールしてください。拡張機能のページで「Install」ボタンをクリックするとインストールが開始されます。

2.3 設定ファイルの作成と編集

VSCodeでVBA開発を行うためには、いくつかの設定ファイルを作成する必要があります。主に以下の2つのファイルを作成します。

  • .vscode/settings.json: VSCodeの設定ファイル。VBA拡張機能の設定や、コードフォーマットの設定などを記述します。
  • .vscode/launch.json: デバッグ設定ファイル。デバッグ実行時の設定（Excelの起動方法やVBAファイルのパスなど）を記述します。

2.3.1 .vscode/settings.json の作成と編集

  1. .vscode フォルダを作成する: VSCodeでVBAプロジェクトのルートフォルダを開き、エクスプローラービューでフォルダを右クリックして「新しいフォルダ」を選択し、.vscode という名前のフォルダを作成します。
  2. settings.json ファイルを作成する: .vscode フォルダ内で右クリックし、「新しいファイル」を選択し、settings.json という名前のファイルを作成します。
  3. settings.json ファイルを編集する: 作成した settings.json ファイルを開き、以下の内容を記述します。

json
{
"vba.executablePath": "C:\\Program Files\\Microsoft Office\\root\\Office16\\EXCEL.EXE",
"vba.language": "ja-JP",
"editor.formatOnSave": true,
"files.encoding": "shiftjis"
}

  • vba.executablePath: Excelの実行ファイルのパスを指定します。パスは、自分の環境に合わせて変更してください。
  • vba.language: VBAの言語設定を指定します。日本語環境では “ja-JP” を指定します。
  • editor.formatOnSave: ファイル保存時に自動でコードをフォーマットするかどうかを指定します。true にすると自動でフォーマットされます。
  • files.encoding: VBAファイルのエンコーディングを指定します。Shift-JIS環境では “shiftjis” を指定します。UTF-8環境の場合は “utf8” を指定します。

2.3.2 .vscode/launch.json の作成と編集

  1. launch.json ファイルを作成する: .vscode フォルダ内で右クリックし、「新しいファイル」を選択し、launch.json という名前のファイルを作成します。
  2. launch.json ファイルを編集する: 作成した launch.json ファイルを開き、以下の内容を記述します。

json
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch Excel VBA",
"type": "vba",
"request": "launch",
"program": "excel",
"macro": "Module1.Main",
"excelPath": "C:\\Program Files\\Microsoft Office\\root\\Office16\\EXCEL.EXE",
"file": "${workspaceFolder}/module1.bas"
}
]
}

  • name: デバッグ構成の名前を指定します。
  • type: デバッグタイプを指定します。”vba” を指定します。
  • request: デバッグリクエストを指定します。”launch” を指定します。
  • program: 実行するプログラムを指定します。”excel” を指定します。
  • macro: 実行するマクロの名前を指定します。モジュール名.プロシージャ名 の形式で指定します。
  • excelPath: Excelの実行ファイルのパスを指定します。settings.json と同じパスを指定してください。
  • file: VBAファイルのパスを指定します。

これらの設定ファイルを作成することで、VSCodeでVBA開発を行うための基本的な環境が整います。

3. 必須の拡張機能で開発効率を爆上げ

VSCodeの強みは、豊富な拡張機能によって開発環境を自由にカスタマイズできる点です。ここでは、VBA開発に必須と言える拡張機能を紹介します。

3.1 VBA (Visual Basic for Applications)

概要: VBAのシンタックスハイライト、コード補完、デバッグ機能などを提供する、VBA開発の基盤となる拡張機能です。

特徴:

  • シンタックスハイライト: VBAコードを色分け表示し、可読性を向上させます。
  • コード補完: VBAのキーワード、オブジェクト、メソッドなどを自動的に補完します。
  • デバッグ機能: ブレークポイントの設定、ステップ実行、ウォッチ式の利用など、VBAコードのデバッグを支援します。
  • コード定義へのジャンプ: 変数やプロシージャの定義箇所に簡単にジャンプできます。

インストール: 拡張機能ビューで “VBA (Visual Basic for Applications)” を検索し、インストールします。

3.2 Excel-VBA-Formatter

概要: VBAコードを自動的に整形し、可読性を向上させる拡張機能です。

特徴:

  • インデントの自動調整: コードのインデントを自動的に調整し、構造を明確にします。
  • 大文字・小文字の統一: VBAキーワードや変数名の大文字・小文字を統一します。
  • 空白の調整: 不要な空白を削除したり、適切な空白を追加したりします。

インストール: 拡張機能ビューで “Excel-VBA-Formatter” を検索し、インストールします。

設定: settings.json ファイルに以下の設定を追加することで、フォーマットルールをカスタマイズできます。

json
{
"vba-formatter.indentStyle": "space",
"vba-formatter.indentSize": 4,
"vba-formatter.lineEnding": "crlf"
}

  • indentStyle: インデントにスペースを使用するかタブを使用するかを指定します。
  • indentSize: インデントの幅を指定します。
  • lineEnding: 改行コードを指定します。

3.3 Code Spell Checker

概要: コード内のスペルミスを検出する拡張機能です。

特徴:

  • 変数名、コメント、文字列リテラルなどのスペルミスをリアルタイムで検出します。
  • スペルミスの候補を表示し、修正を支援します。
  • カスタム辞書を定義し、特定の単語を無視するように設定できます。

インストール: 拡張機能ビューで “Code Spell Checker” を検索し、インストールします。

設定: settings.json ファイルに以下の設定を追加することで、スペルチェックの設定をカスタマイズできます。

json
{
"cSpell.words": [
"myvariable",
"MyConstant"
],
"cSpell.ignoreWords": [
"TODO"
]
}

  • cSpell.words: カスタム辞書に登録する単語を指定します。
  • cSpell.ignoreWords: スペルチェックを無視する単語を指定します。

3.4 その他おすすめ拡張機能

  • VBA Syntax Highlighting: VBAのシンタックスハイライトを強化する拡張機能です。標準のVBA拡張機能よりも細かい色分け表示が可能です。
  • Bracket Pair Colorizer 2: 対応する括弧を色分け表示し、コードの可読性を向上させる拡張機能です。
  • TODO Highlight: コード内のTODOコメントを強調表示する拡張機能です。タスク管理に役立ちます。
  • GitLens — Git supercharged: Gitの機能を強化し、コードの変更履歴を視覚的に表示する拡張機能です。

これらの拡張機能を導入することで、VBA開発環境を大幅に強化し、開発効率を向上させることができます。

4. VSCodeでVBA開発を実践する

4.1 新規VBAプロジェクトの作成

VSCodeでVBAプロジェクトを作成するには、まず任意のフォルダを作成し、VSCodeでそのフォルダを開きます。

次に、VBAファイル（.bas、.cls、.frm など）を作成します。ファイルを作成する際には、拡張子を正しく指定してください。

4.2 コードの記述と実行

VBAファイルにコードを記述します。VSCodeのコード補完機能やシンタックスハイライト機能を活用して、効率的にコーディングできます。

コードを実行するには、launch.json ファイルで設定したマクロを実行します。VSCodeのデバッグビューを開き、「Launch Excel VBA」を選択して実行ボタンをクリックします。

4.3 デバッグ機能の活用

VSCodeのデバッグ機能は、VBEよりも強力で、効率的なデバッグを可能にします。

4.4 ブレークポイントの設定とステップ実行

コードの特定の行にブレークポイントを設定し、プログラムの実行を一時停止させることができます。ブレークポイントは、コードエディタの左側の余白をクリックすることで設定できます。

ステップ実行機能を使用すると、コードを1行ずつ実行し、変数の値やプログラムの実行フローを確認できます。ステップイン、ステップオーバー、ステップアウトなどの機能を利用して、コードの動作を詳細に分析できます。

4.5 イミディエイトウィンドウの利用

デバッグ中に、イミディエイトウィンドウを使用して、変数の値を表示したり、VBAコードを実行したりできます。イミディエイトウィンドウは、デバッグビューの下部に表示されます。

イミディエイトウィンドウに ? 変数名 と入力してEnterキーを押すと、変数の値が表示されます。また、Debug.Print 変数名 と入力してEnterキーを押すと、イミディエイトウィンドウに値が出力されます。

5. Git連携でバージョン管理を強化する

VBA開発において、バージョン管理は非常に重要です。GitとVSCodeを連携させることで、VBAファイルの変更履歴を管理し、複数人での共同開発を円滑に進めることができます。

5.1 Gitのインストールと初期設定

Gitがインストールされていない場合は、公式サイト (https://git-scm.com/) からダウンロードしてインストールしてください。

インストール後、Gitの初期設定を行います。コマンドプロンプトやターミナルを開き、以下のコマンドを実行します。

bash
git config --global user.name "Your Name"
git config --global user.email "[email protected]"

Your Name と [email protected] は、自分の名前とメールアドレスに置き換えてください。

5.2 リポジトリの作成とコミット

VBAプロジェクトのルートフォルダで、以下のコマンドを実行してGitリポジトリを初期化します。

bash
git init

次に、VBAファイルをリポジトリに追加します。

bash
git add .

git add . は、すべてのファイルをリポジトリに追加するコマンドです。特定のファイルだけを追加したい場合は、git add ファイル名 と入力します。

ファイルをリポジトリに追加したら、コミットを行います。コミットとは、変更履歴を記録する操作です。

bash
git commit -m "Initial commit"

-m オプションは、コミットメッセージを指定するオプションです。コミットメッセージは、変更内容を説明する短い文章を記述します。

5.3 ブランチの活用とマージ

ブランチとは、コードの変更を隔離するための機能です。新しい機能を追加したり、バグを修正したりする際には、新しいブランチを作成して作業を行うのが一般的です。

新しいブランチを作成するには、以下のコマンドを実行します。

bash
git branch feature/new-feature

feature/new-feature は、ブランチ名です。

作成したブランチに切り替えるには、以下のコマンドを実行します。

bash
git checkout feature/new-feature

ブランチで作業が完了したら、メインブランチ（master や main など）にマージします。マージとは、ブランチの変更内容をメインブランチに取り込む操作です。

まず、メインブランチに切り替えます。

bash
git checkout main

次に、マージを行います。

bash
git merge feature/new-feature

マージ時にコンフリクトが発生した場合は、手動でコンフリクトを解決する必要があります。

6. さらなる効率化！便利な設定とテクニック

6.1 スニペットの活用

スニペットとは、よく使うコードの断片を登録しておき、短いキーワードを入力するだけで展開できる機能です。VBA開発では、プロシージャの定義やループ処理など、定型的なコードを記述する機会が多いため、スニペットを活用することで、大幅な効率化が可能です。

VSCodeでスニペットを作成するには、以下の手順を実行します。

  1. スニペットファイルを開く: VSCodeのメニューから「ファイル」→「ユーザー設定」→「ユーザー スニペット」を選択し、VBAのスニペットファイル (vba.json) を開きます。
  2. スニペットを定義する: vba.json ファイルに、以下の形式でスニペットを定義します。

json
{
"Sub Procedure": {
"prefix": "sub",
"body": [
"Sub ${1:ProcedureName}()",
"\t${2:Code}",
"End Sub"
],
"description": "Sub Procedure"
},
"For Loop": {
"prefix": "for",
"body": [
"For ${1:i} = ${2:1} To ${3:10}",
"\t${4:Code}",
"Next ${1:i}"
],
"description": "For Loop"
}
}

  • prefix: スニペットを展開するためのキーワードを指定します。
  • body: スニペットとして展開するコードを指定します。
    • ${1:ProcedureName} のように、${番号:デフォルト値} の形式でプレースホルダーを指定できます。プレースホルダーは、スニペット展開後にTabキーで移動して、値を入力できます。
  • description: スニペットの説明を指定します。

上記の例では、sub と入力すると Sub Procedure スニペットが展開され、for と入力すると For Loop スニペットが展開されます。

6.2 キーボードショートカットのカスタマイズ

VSCodeのキーボードショートカットをカスタマイズすることで、よく使う操作をより素早く実行できるようになります。

キーボードショートカットをカスタマイズするには、以下の手順を実行します。

  1. キーボードショートカットファイルを開く: VSCodeのメニューから「ファイル」→「ユーザー設定」→「キーボード ショートカット」を選択し、キーボードショートカットファイル (keybindings.json) を開きます。
  2. キーボードショートカットを定義する: keybindings.json ファイルに、以下の形式でキーボードショートカットを定義します。

json
[
{
"key": "ctrl+shift+f",
"command": "editor.action.formatDocument",
"when": "editorTextFocus && editorLangId == vba"
}
]

  • key: キーボードショートカットを指定します。
  • command: 実行するコマンドを指定します。
  • when: キーボードショートカットを有効にする条件を指定します。

上記の例では、Ctrl+Shift+F を押すと、VBAファイルがフォーマットされます。

6.3 タスクランナーの活用

タスクランナーとは、特定のタスクを自動的に実行するツールです。VBA開発では、VBAファイルのコンパイルや、テストの実行など、定型的なタスクを自動化するために、タスクランナーを活用できます。

VSCodeでタスクランナーを設定するには、以下の手順を実行します。

  1. tasks.json ファイルを作成する: VSCodeでVBAプロジェクトのルートフォルダを開き、.vscode フォルダ内に tasks.json という名前のファイルを作成します。
  2. タスクを定義する: tasks.json ファイルに、以下の形式でタスクを定義します。

json
{
"version": "2.0.0",
"tasks": [
{
"label": "Compile VBA",
"type": "shell",
"command": "vba-compiler",
"args": [
"${workspaceFolder}/module1.bas",
"-o",
"${workspaceFolder}/output.dll"
],
"group": {
"kind": "build",
"isDefault": true
},
"problemMatcher": []
}
]
}

  • label: タスクの名前を指定します。
  • type: タスクの種類を指定します。”shell” は、シェルコマンドを実行するタスクです。
  • command: 実行するコマンドを指定します。
  • args: コマンドに渡す引数を指定します。
  • group: タスクのグループを指定します。”build” グループに登録すると、ビルドタスクとして実行できます。
  • problemMatcher: エラーメッセージを解析するための設定を指定します。

上記の例では、Compile VBA という名前のタスクを定義しています。このタスクは、vba-compiler というコマンドを実行して、VBAファイルをコンパイルします。

タスクを実行するには、VSCodeのメニューから「タスク」→「タスクの実行」を選択し、実行するタスクを選択します。

7. トラブルシューティングとQ&A

7.1 よくある問題と解決策

  • コード補完が動作しない:
    • VBA拡張機能が正しくインストールされているか確認してください。
    • settings.json ファイルの vba.executablePath が正しいExcelのパスに設定されているか確認してください。
    • VBAファイルのエンコーディングが正しいか確認してください。Shift-JIS環境の場合は “shiftjis” を、UTF-8環境の場合は “utf8” を指定します。
  • デバッグが動作しない:
    • launch.json ファイルの設定が正しいか確認してください。
    • excelPath が正しいExcelのパスに設定されているか確認してください。
    • macro が正しいマクロ名に設定されているか確認してください。
    • Excelが起動している状態でデバッグを実行すると、エラーが発生する場合があります。Excelを閉じてからデバッグを実行してください。
  • コードフォーマットが動作しない:
    • Excel-VBA-Formatter拡張機能が正しくインストールされているか確認してください。
    • settings.json ファイルの editor.formatOnSave が true に設定されているか確認してください。
    • settings.json ファイルの vba-formatter 関連の設定が正しいか確認してください。
  • Git連携がうまくいかない:
    • Gitが正しくインストールされ、初期設定が完了しているか確認してください。
    • リポジトリが正しく初期化されているか確認してください。
    • .gitignore ファイルが正しく設定されているか確認してください。

7.2 読者からの質問と回答

Q: VSCodeでVBAプロジェクトを複数同時に開くことはできますか？

A: はい、VSCodeは複数のプロジェクトを同時に開くことができます。複数のウィンドウを開いて、それぞれ別のプロジェクトを開くか、ワークスペース機能を使用して複数のプロジェクトを1つのウィンドウで管理することができます。

Q: VSCodeでVBAのテストを実行する方法はありますか？

A: VBA専用のテストフレームワークはあまり一般的ではありませんが、VBAコードを呼び出すスクリプト言語（Pythonなど）と連携して、テストを実行することができます。

Q: VSCodeでVBA以外の言語も開発できますか？

A: はい、VSCodeはさまざまな言語に対応した拡張機能が豊富に用意されており、VBA以外にもPython、JavaScript、C++など、さまざまな言語の開発に利用できます。

8. まとめ: VSCodeでVBA開発の未来を切り開く

本記事では、VSCodeを使ったVBA開発環境の構築方法と、VBEを卒業するための具体的な手順を解説しました。

VSCodeは、VBEの課題を克服し、VBA開発をより快適にするための多くのメリットを提供します。強力なコード補完、充実したデバッグ機能、Git連携によるバージョン管理、豊富な拡張機能によるカスタマイズなど、VSCodeはVBA開発を大幅に効率化し、より高品質なコードを作成するのに役立ちます。

VBA開発者の皆様は、ぜひVSCodeを導入し、快適なVBA開発環境を構築して、開発効率を向上させてください。

VSCodeは、VBA開発の未来を切り開くための強力なツールです。今こそVBEを卒業し、VSCodeでVBA開発の新たな可能性を追求しましょう。

コメントする

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

上部へスクロール