最新下载
热门教程
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
Visual Basic 2005在语言上的增强（三）XML注释
时间：2022-07-02 11:42:32 编辑：袖梨 来源：一聚教程网
XML注释允许你在代码中添加结构化的文档，并且因为这是C#最先采用的技术，Visual Basic程序员觊觎已久了。XML注释能够描述各种各样的代码元素，包括类、字段成员、方法、以及枚举等等。
一旦你创建了一个描述代码特性的XML注释，当你继续在编辑器里键入代码特性时，你立刻会得到关于参数和返回值的智能感知。假设你现在有一个标志着如下签名的函数原型：
Private Function GetCustomerData(ByVal CustomerCode As String) As DataSet
把代码插入点设置在这个函数声明的上一行并键入三个小撇号。Visual Basic将生成一个和下面函数声明相匹配的XML注释，你可以像填充一个表格那样地填充它。根据你的函数，假设你将你的注释模板填充成如下内容：
'''
''' Returns a DataSet for a single customer.
'''
''' Customer Code as String.
'''DataSet for the supplied CustomerCode.
'''Resides in the application's data layer.
现在你无论在代码的何处键入这个函数名，你都会得到关于这个函数的概要、参数、和返回值的信息的完整智能感知，如图5所示：
图5 当你为你的代码元素添加了XML注释后，你可以立即得到其智能感知反馈，正如这个工具提示所展示的那样。
如果你是在集体协作下完成开发，这就是一个关键的特性。通过插入在源文件中的结构化的XML注释，你可以生成代码文档。并且，一个应用程序的架构师或开发组长可以在实现代码具体细节之前，先设计出原型并给出特性的注释。当开发人员在根据原型填写代码时，智能感知可以指导他们正确地使用到原型的特性。
编译器将把XML注释看作你代码的一部分。注释标签值显示成注释的颜色，而若你没有完整地规划出XML注释的话（作者意思是没有设计完整的函数原型，例如没有给出参数列表，涕淌注），只有summary标签值会显示在完整的XML注释模板上（见图6）。
一旦你创建了一个描述代码特性的XML注释，当你继续在编辑器里键入代码特性时，你立刻会得到关于参数和返回值的智能感知。假设你现在有一个标志着如下签名的函数原型：
Private Function GetCustomerData(ByVal CustomerCode As String) As DataSet
把代码插入点设置在这个函数声明的上一行并键入三个小撇号。Visual Basic将生成一个和下面函数声明相匹配的XML注释，你可以像填充一个表格那样地填充它。根据你的函数，假设你将你的注释模板填充成如下内容：
'''
''' Returns a DataSet for a single customer.
'''
''' Customer Code as String.
'''
'''
现在你无论在代码的何处键入这个函数名，你都会得到关于这个函数的概要、参数、和返回值的信息的完整智能感知，如图5所示：
图5 当你为你的代码元素添加了XML注释后，你可以立即得到其智能感知反馈，正如这个工具提示所展示的那样。
如果你是在集体协作下完成开发，这就是一个关键的特性。通过插入在源文件中的结构化的XML注释，你可以生成代码文档。并且，一个应用程序的架构师或开发组长可以在实现代码具体细节之前，先设计出原型并给出特性的注释。当开发人员在根据原型填写代码时，智能感知可以指导他们正确地使用到原型的特性。
编译器将把XML注释看作你代码的一部分。注释标签值显示成注释的颜色，而若你没有完整地规划出XML注释的话（作者意思是没有设计完整的函数原型，例如没有给出参数列表，涕淌注），只有summary标签值会显示在完整的XML注释模板上（见图6）。