在程序中进行注释:使用注释

更新:2007 年 11 月

在本课中,您将学习如何在程序代码中创建注释。

构成程序的代码可能很难阅读和理解,尤其是当它最初并不是由您编写的时候。通过使用“注释”,可以为您自己或代码的其他用户创建代码说明。

注释是代码编辑器中的文本项,当程序运行时,Visual Basic 编译器会忽略这些内容。因此,您可以为自己写一个说明,解释程序的某个特定部分的作用,或提醒自己完成某些尚未完成的编程任务。

从以 ' 字符打头的一行开始创建注释。下面的示例演示了如何创建注释。

' This is a comment. WOW!

也可以在行尾添加注释(同样是使用 ' 字符)。这么做通常是为了提供有关个别代码行的注释,如下面的示例所示。

MsgBox("Hello World!") ' This line causes a message box to appear.

与单行注释一样,该行中 ' 字符后面的所有内容都将被程序忽略。

使用注释进行调试

注释的另一个用处是在调试程序时暂时阻止一行代码运行。例如,假设您有一行显示消息框的代码。

MsgBox("Hello World!")

如果希望运行程序而不显示该消息框,但又不想永久删除它,就可以使用注释字符 (') 暂时在程序中隐藏它,如下所示。

' MsgBox("Hello World!")

由于 ' 字符后的所有内容都被忽略,程序将运行但不执行该行。稍后可以移除 ' 字符,消息框便会显示出来。

试一试!

插入注释

  1. 在“文件”菜单上,选择“新建项目”。

  2. 在“新建项目”对话框的“模板”窗格中,单击“Windows 应用程序”。

  3. 在“名称”框中键入 Comments,然后单击“确定”。

    一个新的 Windows 窗体项目随即打开。

  4. 双击该窗体以打开代码编辑器。

  5. 在 Form1_Load 事件处理程序中,键入以下代码。

    ' This code will cause two message boxes to appear
    MsgBox("This is Message Box 1") ' Display Message Box 1
    MsgBox("This is Message Box 2") ' Display Message Box 2
    
  6. 按 F5 运行程序。

    程序启动,两个消息框将会依次出现。

  7. 在“调试”菜单上,选择“停止调试”以结束程序。

  8. 在代码编辑器中,将注释字符 (') 添加到第一个消息框行中,使它看起来如下所示。

    ' MsgBox("This is MessageBox 1") ' Ignore Message Box 1
    
  9. 按 F5 运行程序。

    注意,这一次程序会忽略第一行显示消息框的代码,只有第二个消息框出现。

后续步骤

在本课中,您学习了使用注释在代码中创建备注和暂时禁用个别代码行。调试课程到此结束。在下一套课程中,您将学习如何使用数据库存储和检索程序信息。

下一课:管理记录:在程序中使用数据

请参见

概念

代码中的注释

其他资源

什么地方出错了?通过调试查找并修复错误