コード内のコメント (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 行以上のコードを選択し、[編集] ツール バーの [コメント] () ボタンとコメント解除ボタン ()を選択します。

こちらも参照ください

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