编程日日帖(13)

编程爱好者

为自定义类提供动态提示

VS .NET提供了智能感知功能,可以在输入代码时提供动态提示信息。C# 提供了一种机制,可以为用户自定义类型实现这个功能,只需在想添加提示信息的代码前加上以“///”开头的xml注释,然后通过注释内的特殊标记来描述即可。

常用的标记有:

描述类型成员。

指定类或其他类型的概述信息。

在方法声明的注释中使用,以描述该方法的一个参数。

在方法声明的注释中使用,以描述返回值。

在注释中开始一个新段落。

下面例子说明如何使用、定义一个类,并加上注释:

public class Class1

{ ///

这是一个类

/// 这是一个参数

public Class1(string p){} }

在使用Class1时,可以看到如图的效果):

13-g15-1-5.jpg

另外,要在使用编译后的类文件时实现上述功能,还必须做如下操作:

打开项目的“属性页”对话框,单击“配置属性”→“生成”属性页。

修改“XML 文档文件”属性,使.xml 文件的文件名与编译后的类文件同名,并确保在引用类时该 .xml 文件与它在同一目录。