ylbtech-LanguageSamples-XMLdoc

ylbtech-Microsoft-CSharpSamples:ylbtech-LanguageSamples-XMLdoc

 

1.A，示例(Sample) 返回顶部

“XML 文档”示例

本示例演示如何使用 XML 将代码编入文档。有关更多信息，请参见XML 文档注释（C# 编程指南） 。

安全说明
提供此代码示例是为了阐释一个概念，它并不代表最安全的编码实践，因此不应在应用程序或网站中使用此代码示例。对于因将此代码示例用于其他用途而出现的偶然或必然的损害，Microsoft 不承担任何责任。

在 Visual Studio 中生成“XML 文档”示例

1. 在“解决方案资源管理器”中，右击该项目并单击“属性”。

2. 打开“配置属性”文件夹并单击“生成”。

3. 将“XML 文档文件”属性设置为“XMLsample.xml”。

4. 在“生成”菜单中单击“生成”。XML 输出文件将出现在调试目录中。

从命令行生成并运行“XML 文档”示例

1. 若要生成示例 XML 文档，请在命令提示符处键入以下命令：

   csc XMLsample.cs /doc:XMLsample.xml

2. 若要查看生成的 XML，请发出下列命令：

   type XMLsample.xml

1.B，示例代码(Sample Code)返回顶部

1.B.1, XMLSample.cs

// 版权所有(C) Microsoft Corporation。保留所有权利。

// 此代码的发布遵从

// Microsoft 公共许可(MS-PL，http://opensource.org/licenses/ms-pl.html)的条款。

//

//版权所有(C) Microsoft Corporation。保留所有权利。



// XMLsample.cs

// 编译时使用：/doc:XMLsample.xml

using System;



/// <summary>

/// 此处显示类级别摘要文档。 </summary>

/// <remarks>

/// 较长的注释可通过 remarks 标记与类型或成员 

/// 关联 </remarks>

public class SomeClass

{

   /// <summary>

   /// Name 属性的存储区</summary>

   private string myName = null;



   /// <summary>

   /// 类构造函数。 </summary>

   public SomeClass()

   {

       // TODO: 在此处添加构造函数逻辑

   }

   

   /// <summary>

   /// Name 属性 </summary>

   /// <value>

   /// value 标记用于描述属性值</value>

   public string Name

   {

      get 

      {

         if ( myName == null )

         {

            throw new Exception("Name is null");

         }

             

         return myName;

      }

   }



   /// <summary>

   /// SomeMethod 的说明。</summary>

   /// <param name="s"> 此处显示 s 的参数说明</param>

   /// <seealso cref="String">

   /// 可以在任何标记上使用 cref 特性来引用类型或成员

   /// 编译器将检查该引用是否存在。 </seealso>

   public void SomeMethod(string s)

   {

   }



   /// <summary>

   /// 一些其他方法。 </summary>

   /// <returns>

   /// 返回结果通过 returns 标记描述。</returns>

   /// <seealso cref="SomeMethod(string)">

   /// 注意引用特定方法的 cref 特性的使用 </seealso>

   public int SomeOtherMethod()

   {

      return 0;

   }



   /// <summary>

   /// 应用程序的入口点。

   /// </summary>

   /// <param name="args"> 命令行参数列表</param>

   public static int Main(String[] args)

   {

      // TODO: 在此处添加启动应用程序的代码



       return 0;

   }

}

View Code

1.B.2,

1.B.EXE,

1.B,

1.C，下载地址(Free Download)返回顶部

 

作者：ylbtech 出处：http://ylbtech.cnblogs.com/ 本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。