Visual Basic 2005在语言上的增强(三)XML注释

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

时间: 2024-08-04 01:45:42

Visual Basic 2005在语言上的增强(三)XML注释的相关文章

Visual Basic 2005在语言上的增强(十三)显式的数组范围及小结

visual|数组 显式的数组范围 你现在可以使用显式的数组范围来声明数组,这样的声明更加清晰可读了:Dim a(10) As Integer '旧方式Dim b(0 To 10) As Integer '新方式 Visual Basic中的数组范围仍然是以零为起始,所以如果你想声明一个不是以零为起始范围的数组,你就会得到一个编译器错误. 小结 Visual Basic 2005语言获得了一些重要的特性以及诸多细微的增强,这些都极大地提高了它的易用性和开发人员的生产效率.这个语言变得更加完善,并

关于Visual Basic 2005窗体互访技术的思索

visual 每一天,都有VB6的程序员开始转入.NET开发,而他们面临的最首要的问题,便是要习惯.NET里那些面向对象的金科玉律.因此,论坛上总会重复地听到网友们讨论如何在Visual Basic .NET 2003中进行窗体之间的互相访问的问题.早些时候,我特地发表了一篇关于此问题解决方案的文章,通过重写Sub New,利用Me关键字在新窗体中获得另一个窗体的实例.现在VB2005的时代马上要到来了,会不会有更简单的方法呢?答案是肯定的,所有的奥秘都藏在了My.Forms命名空间里! 其实这

从 VBA 中使用 Visual Basic .NET 将 Word 文档序列化为 XML

visual|word|xml 从 VBA 中使用 Visual Basic .NET 将 Word 文档序列化为 XML Michael CorningMicrosoft Corporation 2002年10月 适用于:   Microsoft Word 2002   Microsoft Visual Studio .NET 摘要:学习如何在 Microsoft Office Visual Basic for Applications (VBA) 程序中利用 .NET 代码将大型 Word

体验Visual C++ 2005的现代语言特性(1)

当年Visual Studio.NET 2003 C++编译器的面世,令无数C++语言爱好者都对此垂涎不已:它与ISO C++标准保持98%的一致--这比以前任何一个版本都更加接近,和一体化的语言支持特性,如局部模板特定化:同时也包括了增强的缓冲区安全检查和改进的编译器诊断功能.以往使用C#和Visual Basic.NET的开发者,通过简单的拖放操作,就能生成稳健的Windows窗体应用程序,如今,C++的开发者也加入了进来,而且,这个编译器还对Intel Pentium 4和AMD Athl

Visual Basic.NET 中的语言新变化

visual 简介 要快速创建企业级的Web应用程序,开发人员必须依赖于可伸缩性.强壮性和可重用性等商业逻辑.在过去的几年中,面向对象的程序设计成为符合这些要求的系统的首要方法.使用面向对象的编程语言有助于使大规模的系统更易于理解.更易于调试.升级更迅速. 为了使Visual Basic开发人员能够从面向对象设计中受益并简化企业级Web应用程序的开发,Visual Basic的下一个版本­--Visual Basic.NET将支持包括实现继承在内的全部面向对象的语言特性.有了这些语言特性,Vis

Visual Basic迎来第20个生日

导语:Christiaan Baes是一名技术专家,同是也是一名VB.NET的粉丝.在他的博文中写到:当我在看VBTeam时得知5月20日是Visual Basic的20岁生日.在这二十年来,Visual Basic一度是世界上开发者人数最多的一种语言之一,并持久不衰. 这一切还要追溯到1991年比尔·盖茨推出了Visual Basic 1.0版.这在当时引起了很大的轰动,许多专家都把VB的出现当做是软件开发史上的一个具有划时代意义的事件.事实上,它最初在1988年以名为Ruby的代码项目开始,

向Visual Basic程序员介绍My命名空间(一)

visual|程序|程序员|命名空间 Excerpted from "Microsoft Visual Basic Programmer's Introduction to Whidbey" by Sean Campbell, Scott Swigart, Kris Horrocks, Derek Hatchard, and Peter Bernhardt. Publisher, Microsoft Press, ISBN # 0-7356-2058-X. 2004, Microsof

体验Visual C++ 2005的现代语言特性(5)

可靠的安全 在2002年,Bill Gates宣布进行的可信赖计算,已对微软公司开发的所有产品带来了深刻的影响.Windows操作系统的开发者花了数月的时间来进行安全方面的训练及代码重审,带来的结果就是,Windows Server 2003成了该公司有史以来发布的最安全的操作系统.Microsoft Office 2003也包含了许多的安全功能,像IRM(Information Rights Management).加强的宏安全.Outlook中阻止下载HTML等等.而Visual C++ 2

Visual Basic .NET中的语言创新

visual Visual Basic .NET中的语言创新 引言 要快速地创建企业Web应用程序,开发人员必须依靠可伸缩的.健壮的.可重用的商务逻辑.在过去的几年中,面向对象的程序设计已经成为了创建满足这些需求的系统的主要技术.使用面向对象的程序设计语言可以使得大型系统更容易理解,更容易调试,并且更新速度更快. 为了使Visual Basic开发人员从面向对象的设计中获益,简化企业Web应用程序的开发,将在Visual Basic的下一个版本 - Visual Basic .NET中支持包括实