Visual Studio.net中的XML注释
介绍 在这个实践训练中,你将在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。 注重: 当你用这种方式启动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。
创建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"中间没有空格. 4.点击Open. 5.在页面中敲入下面的代码: using System; class XmlElement { /// /// Returns the attribute with the given name and /// namespace /// /// The name of the attribute /// /// The namespace of the attribute, or null if /// the attribute has no namespace /// /// The attribute value, or null if the attribute /// does not exist /// public string GetAttr(string name, string ns) { return "test"; } }
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 SettingsAdministratorMy DocumentsVisual Studio ProjectsXMLComments 4.点击XMLComments.csproj或XMLComments.sln,然后点击Open。 注重:点击两个中的任何一个文件都可以打开项目 假如在主窗口中没有打开源文件,在Solution Explorer窗口中双击XMLComments.cs.(见图4)。源文件就会在主窗口中打开。保持IDE的打开状态,y以完成下面的步骤. 注重: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:FieldContentExperience VS.NETLab2。 3.高亮选中文件doc.xsl和make.bat,点击Edit,再点击Copy。 4.打开路径C:Documents and SettingsAdministratorMy DocumentsVisual Studio ProjectsXMLComments。 5.点击Edit,再点击Paste将文件粘贴到XMLComments文件夹中。你将使用MS-DOS命令行来编译这个项目。 6.在Windows Explorer中,打开路径C:FieldContentExperience VS.NETLab2。 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,然后按回车键。 注重:当使用make命令编译结束后,doc.xml XMLComment.dll文件就被创建了。并且它们会被自动存放到XMLCommand项目文件夹中。对于C#来说,这是缺省的。你不必指明存储路径除非你想改变它。 10.关闭命令提示. 在XML文件中应用XSL模板 你现在将要把XSL模板应用于你创建的XML文件。你要在IDE中打开XML和XSL文件,然后再应用XSL模板,这样XML.doc才可以准确地在Web浏览器中显示。 1.在IDE中,点击File,再点击Add Existing Item。 2.打开路径C:Documents and SettingsAdministratorMy DocumentsVisual Studio ProjectsXMLComments.
3.点击doc.xml,再按Open按钮。doc.xml文件将在IDE中打开.你现在可以在Web浏览器上打开doc.xml原始文件 4.点击View,再点击Open With。 5.点击IExplore.exe,再点击Open。Doc.xml原始文件就在Microsoft Internet Explorer中打开. 注重:Internet Explorer用一系列"-"符号显示未格式化的XML文件 6.要关闭Internet Explorer,先点击File,再点击Close。 7.在IDE中打开doc.xsl模板:点击File,再点击Add Existing Item。 8.打开路径C:Documents and SettingsAdministratorMy DocumentsVisual Studio ProjectsXMLComments 9.在Files of type中选择All Files,这将使doc.xsl文件名显示出来。 10.点击doc.xsl,接着按Open。doc.xsl就在IDE中打开. 注重:doc.xsl文件的第二行有一个被注释掉的处理指令:,我们将在下一步骤里把它加到XML文件中。 11.将doc.xsl模板应用到doc.xml文件中:高亮选择doc.xsl模板第二行的XML处理命令。点击Edit,再点击Copy。 12.点击doc.xml标签。 13.在和标签之间插入一空行。 14.把光标放置在空行上,点击Edit,再点击Paste。 15.点击File,再点击Save doc.xml。 16.当你存完一个文件后,请注重在处理指令中的冒号不见了。然后需要在"xml"和"stylesheet"(不包括引号,就象图11中的第二行指令相同)之间加一个破折号(-),让处理指令能正常工作。在插入一个破折号后,点击File,再点击Save doc.xml。 打开doc.xml最终版本 你现在可以在浏览器中观看应用了类型表单的doc.xml。请确认在IDE中选定doc.xml标签。 1.点击View,再点击Open With。 2.点击Iexplore.exe,再点击Open。doc.xml 文件将以doc.xsl的格式显示在浏览器上。
结束 1.点击File,再点击Close关闭Internet Explorer。 2.点击File,再点击Exit关闭IDE。
返回类别: 教程 上一教程: 利用XMLHTTP无刷新添加数据之Post篇 下一教程: XML编程方面的扩展
您可以阅读与"Visual Studio.net中的XML注释"相关的教程: · 使用XSL将XML文档中的CDATA注释输出为HTML文本 · 利用XML实现通用WEB报表打印实际使用中的例子 · XML--INTERNET的“世界语” · 存储.NET应用程序到定制的XML .config文件中 · 用VB.NET和XPath简化XML导航
|