Visual Studio.net中的XML注释 (1)-.NET教程,.NET Framework

visual studio.net中的xml注释

10/18/2001 11:1:33· · ··yesky

介绍 　　在这个实践练习中，你将在c#源文件中插入xml注释，然后通过c#编译器生成xml文件。你可以在c#源代码中使用xml相关的注释标记，这些标记被用来指明哪些注释需要输出到xml文件。 　　xml文件可以作为代码文档。你可以在现存的文件中加入新的注释，或者修改现有注释，以保持文档和它对应代码的一致性。为了创建一个更新的文档记录，你要重新生成xml文件。 　　在本练习中，你将要: 　　 · 使用微软visual studio.net集成开发环境创建和编辑一个项目文件 　　 · 创建一个xml文件(doc.xml) 　　 · 在ide中打开项目和源文件 　　 · 用ms-dos命令编译项目 　　 · 在xml文件中应用xsl模板 　　 · 打开doc.xml最终版本 　　在ide中创建一个新的项目 　　1．点击start，点击programs，点击microsoft visual studio.net7.0，然后再点击microsoft visual studio .net 7.0。ide启动页面就会显示，如图1。 　　　　　　　　图1 visual studio.net ide启动页面 　　注意： 　　当你用这种方法启动ide时，缺省启动页面就会打开。它提供了在此工作环境下的最近四个项目的链接，还提供了一些其它资源的链接。 　　你可以改变你的缺省设置。点击tools，再点击options，然后选择你喜欢的设置。 　　2．点击file，点击new，再点击project。new project窗口就会出现，如图2。 　　3．在project types面板里点击visual c# projects，在templates面板上中点击empty project。 　　4．在name字段中，键入xml comments，然后选择你的项目存放的位置(在本操作中我们使用缺省位置)。 　　　　注意：在这个项目名中,"xml"与"comments"中间有一个空格。 　　5．点击ok。 　　　　　　　　　　　图2. new project窗口

　　创建xmlcomment.cs源文件

　　xmlcomment.cs文件是用来创建xml文档的源文件。xml标签及其相关文本在c#代码中被注释掉了。此源文件在编译时，就通过这些xml标签和文本生成xml文档。

　　注意：

　　xml注释标记是新加入c#的。在文本前面以三斜杠（///）打头，它会告诉编译器斜杠后面的文本是xml注释。我们必须以三斜杠开头以声明这一行为xml注释行。xml注释必须采用xml标签的格式，这样才能生成xml文档。

　　1．点击file，再点击add new item。add new item窗口将显示如图3。

　　2．在categories面板里点击local project items，在templates面板中点击code file。

　　3．在name字段中键入xmlcomment.cs。

　　　注意："xmlcomment.cs"中间没有空格.

图3.add new item窗口

　　4．点击open.

　　5．在页面中敲入下面的代码：

　　6．点击file，再点击save xmlcomments.cs（或点击save图标）。该文件就被存到你的项目文件夹中。

　　7．点击file，再点击exit。如果microsoft development窗口出现，点击yes保存你的项目。

　　在ide中打开项目和源文件

　　1．点击start，点击programs，点击microsoft visual studio.net7.0，然后再点击microsoft visual studio .net 7.0。

　　2．点击file，点击open，再点击project。

　　3．打开路径c:\documents and settings\administrator\my documents\visual studio projects\xmlcomments

　　4．点击xmlcomments.csproj或xmlcomments.sln，然后点击open。

　　　注意：点击两个中的任何一个文件都可以打开项目

　　如果在主窗口中没有打开源文件，在solution explorer窗口中双击xmlcomments.cs.(见图4)。源文件就会在主窗口中打开。保持ide的打开状态，y以完成下面的步骤.

图4.xmlcomment.cs文档在ide中的视图

　　注意：system名字空间（namespaces）被声明在在文件顶端。所以这个名字空 间中的所有类在xmlelement类中可用。

　　xml元素"param"有两个属性，name和ns。我们把这些属性值作为参数传递给getattr()。

　　编译

　　在本章中，你将使用两个现存的文件，make.bat 和doc.xsl。这些文件必须存放在xmlcomments项目文件夹中，此项目才能被正确编译。

　　注意：doc.xsl文件提供了类型表模板，用以在web浏览器中显示doc.xml文件。make.bat文件包含c#编译选项。

　　1．点击start，点击programs，点击accessories，再点击windows exployer。

　　2．打开路径c:\fieldcontent\experience vs.net\lab2。

　　3．高亮选中文件doc.xsl和make.bat，点击edit，再点击copy。

　　4．打开路径c:\documents and settings\administrator\my documents\visual studio projects\xmlcomments。

　　5．点击edit，再点击paste将文件粘贴到xmlcomments文件夹中。你将使用ms-dos命令行来编译这个项目。

　　6．在windows explorer中，打开路径c:\fieldcontent\experience vs.net\lab2。

　　7．双击command prompt。

　　8．敲入type make.bat，然后按回车键。屏幕上会显示make.bat file文件的内容。

　　　注意：make.bat file文件包含下面的参数：

　　　csc命令调用了c#编译器

　　　/ target选项具体指明输出文件的格式。在这个例子里，它是一个库文， 即dll（xmlcomment.dll）。

　　　/doc选项告诉编译器从源文件的文档注释中创建一个xml文件(doc.xml)

　　　xmlcomment.cs是需编译的源文件。

　　9．键入make，然后按回车键。命令行提示窗口就会显示如图5。

　　　注意：当使用make命令编译结束后，doc.xml xmlcomment.dll文件就被创建了。并且它们会被自动存放到xmlcommand项目文件夹中。对于c#来说，这是缺省的。你不必指明存储路径除非你想改变它。

图5.生成doc.xml后的dos命令窗口

　　10．关闭命令提示.

doc.xsl的下载地址：http://msdn.microsoft.com/code/default.asp?url=/code/sample.asp?url=/msdn-files/027/001/686/msdncompositedoc.xml