ビジュアル・ベーシックでコメントを追加する方法

マイクロソフトのコンピュータ・プログラミング言語、ビジュアル・ベーシックは、長年にわたってプログラミング界で人気を博してきた。プログラマーはあらゆる種類のプロジェクトにVisual Basicを使用している。このプログラミング言語のバリエーションはウェブページに使用され、他のタイプのVisual Basicプログラムは、私たちが毎日使用するWindowsアプリケーションの多くに使用されています。ビジュアル・ベーシックの本質的な要素のひとつは、コメントを含める機能です。コメントとは、機能的なコードの目的を持たない、コードに埋め込まれたメモのことです。Visual Basicは、これをコードと区別するために特定のプロトコルを使用します。コメントを追加することは、人間のコード・ビューアーがコード・モジュールを正しく読めるようにするために、ほとんどのプロジェクトで非常に重要です。Visual Basicにコメントを追加する必要がある場合、これを正しく行うための基本的な手順を以下に示します。

1

どのタイプのコメントを追加するかを決定します。プログラマーには、コメントの主な目的がいくつかあり、それによってコメントに含まれる正確な形式やスタイルが決まります。

• コード・モジュール・コメントを考えてみましょう。モジュール・コメントは、通常、コード・モジュールの全体的な目的や、著作権、作者などの他の情報を記述する、より高レベルのコメントです。
• プロシージャー・コメントの必要性を評価する。さまざまな機能コードのプロシージャーもコメントする必要があります。プロシージャー・コメントは、コードの特定の機能に関連し、プロシージャーの書き方に従って、プロシージャーの正確な結果を他のプログラマーに警告するのに役立ちます。

2

コード・コメントの用途を細かく分類しましょう。プロシージャー・コメントのように、いくつかのタイプのコメントにはさまざまな形があります。あなたのプログラムに適切な種類のコメントを追加するために、これらの異なる用途を理解してください。

• プロシージャーに対する目的コメントの使い方を評価する。これは、プロシージャが何をするのかを記述するものです。
• 関数の戻り値コメントの使用を検討する。これらは、プロシージャがどのような値を返すのかを他の人が理解するのに役立ちます。
• 条件付きコメントを含める。条件付きコメントは、起こりうるエラー条件やエラー処理、コードが正しく動作するために満たさなければならない条件を記述することができます。

3

コメントの書式を選ぶ。特定のコード行にどのようにコメントを追加するかという問題もあります。

• 左巻きコメントを活用しよう。このコメントは画面の左から始まり、行をまたいでずっと続く。一般的に、コーダーは画面の右端付近でコメントを任意に終了させ、改行してコメントを続ける必要がある。
• インライン・コメントを使う。インライン・コメントは、コードの後に直接アポストロフィーを付け、同じ行に配置します。

4

アポストロフィでコメントの開始を示す。これは、実際にコメントをコードに書き込むための重要なステップです。アポストロフィは、Visual Basicコンパイラがコメント用に認識する特定のテキスト・プロトコルです。これがないと、コンピューターはコメントをコードとして読もうとします。

この記事は、CC BY-NC-SAの下で公開されている「 How to Add Comments in Visual Basic」を改変して作成しました。特に断りのない限り、CC BY-NC-SAの下で利用可能です。