在刚开始用dll时,通常会有这种的疑问:为什么自己生成的dll会没有注释,.Net类型中的注释是怎么来的?后来才知道,为准备生成dll的类添加注释是有讲究的,是有格式规范的。
要使生成的dll在“从元数据”查看的时候有注释,须先在项目属性中的“生成”一栏的输出选项上勾选“XML文档文件”。
然后,注释的格式要规范,所有的注释都要使用下图所示的标准格式(在成员上面写三个“/”就会自动生成)::
类、属性
///
/// max of two
///
方法
///
/// max of two
///
///
///
/// max
public static int GetMax(int a, int b)
{
return (a > b ? a : b);
}
可以看出注释是XML格式的,写好注释后再次“生成”,会发现同一目录下多出了一个与dll文件同名的XML文件,里面就是从程序集中提取的XML注释。
以后再从元数据查看定义时,就会发现上面多出了注释。