把VS.NET源代码文件中C# XML注释提取成工程文档(6)

前面例子中扩展名的其他部分也是有意义的。"MyNamespace.MyType.MyMember"这个值是一个能够被C#编译器找到的完全名称，这个名称可以使用分隔符分成几部分，每一部分都有它对应的意思："MyNamespace" 对应名称空间，"MyType"对应类，"MyMember"对应成员。

如果cref的值不能被找到的话，编译器将用"!:" 来作为前缀。（看图7）

图7：cref 例子

cref 的属性不仅在上面的解码中用，它的成员名在转换为xml文档中也被使用，就像你下面要看到的。

  
    Name
  
  
    
      XML Comments are here
    
    ...
  

第一行是标准的头，下面是根标记。在下面是。在 里面是。是代码所生成工程的程序集名，因此通常只有一个 条目。这个值通常是C#编译器提取的工程名，它与代码中的xml注释没有任何关系。

接下来是，它包含每一个有联系的xml注释，每一个成员都有一个它自己的。
有个属性name，C# 解析器获得关联xml注释对应的成员名字作为这个属性的值。我已经描述过这个值的命名规范，剩下的由所包含的xml由实际的代码文件中的xml注释所组成，前面我已经提及。

产生帮助文件

一个文档罗列所有xml注释几乎是不可能的，通常我们使用XSLT去解析XML为 Html 帮助页面。

我新建了一个名叫GiveHelp的工程，它里面包含一个简单的名叫GiveHelpTransforms 的类、几个ASP.net页面和转换为html用的XSLT文件。（文章开头有源代码下载链接）。这个Web应用把本地xml文件转换为一个帮助文件。

这些ASP.NET页面把转换后的结果在浏览器中展现，他们使用了GiveHelpTransforms类的接口去转换xml为html。
采用GiveHelpTransforms类有两个理由：首先， 其他工程也可以利用这个代码实现从xml到html的转换；其次，在这个示范工程中，我需要一个类来演示这个转换。听起来有些混乱，但是通过我的例子演示，你就会知道该如何做。
转换

在这一节中，我假设你已经了解了XSLT，因此我只是简单的讲如何把xml文档转换为html。

我把帮助系统分作三层，最顶层是类列表。这个页面罗列xml文档中所有的类的细节信息，演示看图8。

图8：类列表页面