コメント機能を使って効率よくコードを用意する
VBEにコードを書いてから数日後・・・ご自身で書いたコードを見た際
「あれ？分からない。何を書いたか忘れてしまった・・・」という経験をされた事ありませんか？
私はコードを書き始めた頃によく経験しました。
そんな時の為にあるコメント機能ですが初心者の頃は効率の良い使い方が分かりません。
効果が分からないのでコメントを書かなくなることが多かったです。
最初はコメントを書く事自体が負担です。
単純にそこまで気が回らないので便利さを感じる余裕が無いです。
コメント機能はうまく使えるとご自身を助けてくれる非常に便利な機能です。
今一度コメント機能を勉強してみましょう。
記事の難易度
非常に易しい内容です。
オンラインミーティング
私オンラインでVBAの講師をしております。ご興味ある方は以下リンクをご覧ください。
この記事を読むとわかる事
改めてコメント機能とは何か見直します。
最後はより簡単な使い方を紹介する事にしています。
- コメント機能とは？
- どんな事ができるのか？
- より簡単な使い方が分かる
マクロ
コメント機能とは
VBEの中にフリーに書く事が出来る文字です。
どんな事ができるのか
どんなコードなのか？どんな事を考えながらコードを書いたのかなどを書き留めておく事が出来ます。
ひとことで表現すると掲示板のような使い方になります。
初心者の頃は単純にコードの意味を書く事で効果を得られます。
理由はコードを書いて数日すると自分でも意味を忘れてしまうからです。
このように勉強初期はコードを書いた数日後に自分を助けてくれる備忘録として使う事になります。
慣れてくるとコードは読めば分かるので他の情報を記入する事になります。
たとえば以下の様な内容です。
- コードの作成日や更新日
- コードの説明
- なぜこのようなコードの仕様にしたのか
3つ挙げましたがこの他にもいろいろな事を書き留めておくことができます。
使い方の見本
プロシージャの序盤でコードの仕様と変数について説明をしているものをサンプルとして提示します。
中身は全く分からないと思いますので気にしなくて良いです。
使い方としてこのような書き方をするというところだけ見てください。
'************************************************************
'2023/05/10
'2次元動的配列
'RedimPreserveは2次元配列の2次元目の要素しか追加できない。
'仕様で変えられないので2次元目を増やして値が入る様に配列を用意する必要がある。
'そのままセルに貼り付けると縦横の情報が逆になるので最後にTransposeで転置。
'************************************************************
Dim A As Variant '配列
Dim B As Variant '配列
Dim C As Variant '配列
Dim Aループ As Long '配列Aをループ
Dim Bループ As Long '配列Bをループ
Dim 最終行 As Long 'リストの最終行を格納
Dim 最終列 As Long 'リストの最終列を格納
Dim 追番 As Long: 追番 = 1 'RedimPreserveで配列の要素を増やす
Dim 格納 As Long '配列Cに値を格納する時に使う（ループ用）
'************************************************************
どんな時にコメントを書く必要があるのか？
ではどんな時にコメントを書けば良いのか？何か基準はあるのか考えてしまいます。
ご自身のステージに合わせて以下のような目安を用意してみました。
まずはこの内容を目安にしてコメントを書く様にしましょう。
初心者
「数日後ご自身がコードを見た時に的確に読み取ることができるか？」を自分に問いかけてください。
「自信がない」、「無理だ」という事になればコードの説明を書く様にしてください。
コメントは数日後の自分への助けになります。できるだけ丁寧に書きましょう。
中級者から上級者
なぜこのようなコードの仕様にしたのか等コード全体の構造をコメントする様にしましょう。
VBAは色々なコードが用意されています。目的の回答に辿り着く方法は何通りもあります。
「なぜこのコードを選んだのか？」を書いておくとグループ内で知識の共有ができます。
コメントを用意するにあたっての注意点
コメントは実行速度には影響しませんが文字が多くなると可読性が落ちます。
詳しく書いて欲しいですが「適格」かつ「短く」書きましょう。
より簡単な使い方
コメントをより間単に用意出来るように便利な使い方を紹介します。
具体的に申し上げますと複数行を一括でコメント、非コメントにする事ができる機能です。
既にVBEの中にアイコンとして用意されています。
表示されていない方も居ます。ここでアイコンの表示を確認しておきましょう。
ツールバーから編集ブロックを表示させる
まずはVBEを表示させてください。
「Alt+F11」orワークシート「開発」タブ内の「VisualBasic」を押下。
VBEについて良く分からない方は以下記事をご覧ください。
表示タブ→ツールバー→編集 を押下。
欄外に編集関連のアイコンボックスが表示されます。
コメントブロック
編集関連のアイコンブロックの右から6つ目のアイコンです。
複数行の文字を一括でコメントに変える事ができます。
以下画像の様にコメントにしたい文字を選択しておきます。
その後コメントブロックのアイコンをクリックしましょう。
以下画像の様に範囲指定した文字は全てシングルクォーテーションが付いています。
これで簡単にコメントを作る事ができます。
非コメントブロック
コメントブロックの右隣のアイコンです。コメントブロックのアイコンに矢印が乗っています。
この機能はコメントブロックの逆の効果を持っています。
コメントを解除したい文字を指定してからアイコンをクリックするとコメントが解除されます。
シングルクォーテーションが全て外れます。
まとめ
コメントの使い方と便利機能を紹介しました。
ここに書いた事はあくまで目安です。
最終的にはご自身で使いやすい運用方法を考えてみてください。
