コード内のコメント (Visual Basic)

コード例にはコメント記号 (') がしばしば見られます。 この記号は、後続のテキスト ("コメント") を無視するように Visual Basic コンパイラに指示します。 コメントは、コードを読むユーザーに役立つように追加される簡単な説明です。

プロシージャの先頭に、そのプロシージャの機能の特性 (何を実行するか) について説明する簡単なコメントを常に配置するのは、推奨されるプログラミング方法です。 コードを作成した本人にとっても、コードを調べる他人にとっても、この説明は役に立ちます。 実装の詳細 (プロシージャの実行手順) は、機能の特性を説明するコメントとは別に記述する必要があります。 実装の詳細を記述に入れる場合は、関数を更新するときにその説明も更新してください。

同じ行のステートメントの後にコメントを入れたり、1 行全体をコメントにしたりできます。 両方の例を次のコードに示します。

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

コメントを複数行に記述する必要がある場合は、以下に例を示すとおりに、各行にコメント記号を記述します。

' This comment is too long to fit on a single line, so we break 
' it into two lines. Some comments might need three or more lines.

コメントのガイドライン

次の表は、どの種類のコメントをコードのセクションの前に配置できるかに関する一般的なガイドラインを示しています。 これらは推奨事項です。Visual Basic にはコメントの追加に関する規則はありません。 コードの作成者自身およびコードを読む他のユーザーに最適な内容を記述してください。

コメント タイプ	コメントの説明
目的	プロシージャが行う内容 (手順ではありません) を説明します。
外部からの影響	各外部変数、コントロール、開いているファイル、またはプロシージャからアクセスされるその他の要素の一覧を示します。
エフェクト	影響を受ける外部変数、コントロール、またはファイル、およびその効果 (明白でない場合のみ) の一覧を示します。
受け取る値	引数の目的を指定します。
戻り値	プロシージャから返される値について説明します。

次のことに留意してください。

• 重要な変数を宣言する場合は、宣言した変数の用途を説明するためのインライン コメントを必ず前に配置します。

• コメントには複雑な実装の詳細だけを記述して済むように、変数、コントロール、およびプロシージャにはわかりやすい名前を付けます。

• 同じ行の行連結シーケンスの後にコメントを付けることはできません。

コード ブロックのコメント記号を追加または削除するには、1 行以上のコードを選択し、[編集] ツールバーの [コメント] () および [コメント解除] () ボタンを選択します。

Note

テキストの前に REM キーワードを付けて、コードにコメントを追加することもできます。 ただし、' 記号および [コメント]/[コメント解除] ボタンの方が使いやすく、必要なスペースとメモリが少なくて済みます。

関連項目

• 基本的な機能 - XML コメントによるコードの文書化
• 方法: XML ドキュメントを作成する
• XML のコメント用タグ
• プログラム構造とコード規則
• REM ステートメント