Visual Basic 代码中的注释

阅读代码示例时,通常会遇到注释符号(')。 此符号告知 Visual Basic 编译器忽略其后面的文本或 注释。 注释是添加到代码中的简短解释性备注,以帮助阅读代码的人。

从描述过程功能特征的简短注释开始所有过程(它的作用)是很好的编程实践。 这是为了你自己的利益和检查代码的任何其他人的利益。 应将实现详细信息(过程如何执行)与描述功能特征的注释分开。 在说明中包含实现详细信息时,请记得在更新函数时对其进行更新。

注释可以在同一行中跟随语句,或占据整个行。 以下代码对此进行了说明。

' 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 不强制实施添加注释的规则。 编写最适合的内容,既适合你,也适合读取代码的任何其他人。

批注类型 注释说明
目的 描述过程的作用(而不是过程如何执行)
假设 列出过程访问的每个外部变量、控件、打开文件或其他元素
影响 列出每个受影响的外部变量、控件或文件,以及它具有的效果(仅当它不明显时)
输入 指定自变量的用途
退货 说明过程返回的值

请记住以下几点:

  • 每个重要的变量声明都应前面有一个注释,描述声明的变量的使用。

  • 应清楚地命名变量、控件和过程,以便仅对复杂的实现详细信息进行注释。

  • 注释不能与行继续符同行。

可以通过选择一行或多行代码并选择“注释”(Visual Studio 中的“Visual Basic 注释”按钮)和“取消The Visual Basic Uncomment button in Visual Studio.注释”(“)来添加或删除代码块的注释符号。

注释

还可以将注释添加到代码中,方法是在文本前面加上 REM 关键字。 但是,符号 '注释/取消注释 按钮更易于使用,并且需要更少的空间和内存。

另请参阅