教程
C# 提供一種機制，供開發人員使用 XML 將其代碼存檔。在源代碼文件中，以下代碼行可以作為注釋處理並放在文件中：以 /// 開始的行；在用戶定義的類型（如類、委托或接口）、某成員（如字段、事件、屬性或方法）或某命名空間聲明之前的行。
示例
下面的示例提供對某個已存檔的類型的基本概述。若要編譯該示例，請鍵入以下命令行：
csc XMLsample.cs /doc:XMLsample.xml
這將創建 XML 文件 XMLsample.xml，您可以在浏覽器中或使用 TYPE 命令查看該文件。
// XMLsample.cs
// compile with: /doc:XMLsample.xml
using System;
/// <summary>
/// Class level summary documentation goes here.</summary>
/// <remarks>
/// Longer comments can be associated with a type or member
/// through the remarks tag</remarks>
public class SomeClass
{
/// <summary>
/// Store for the name property</summary>
private string myName = null;
/// <summary>
/// The class constructor. </summary>
public SomeClass()
{
// TODO: Add Constructor Logic here
}
/// <summary>
/// Name property </summary>
/// <value>
/// A value tag is used to describe the property value</value>
public string Name
{
get
{
if ( myName == null )
{
throw new Exception("Name is null");
}
return myName;
}
}
/// <summary>
/// Description for SomeMethod.</summary>
/// <param name="s"> Parameter description for s goes here</param>
/// <seealso cref="String">
/// You can use the cref attribute on any tag to reference a type or member
/// and the compiler will check that the reference exists. </seealso>
public void SomeMethod(string s)
{
}
