C#的XML兩種代碼注釋執行個體說明

在C/C++,JAVA中，有兩種注釋，一種是單行注釋，即兩根反斜線(//)，另一種是多行注釋，即以/*開頭，以*/結尾。

在Java中，多行注釋(Multiline Comment)分為兩種形式:

1.普通多行注釋,比如

複製代碼 代碼如下:/*
*多行注釋
*/

2.Javadoc注釋,比如 複製代碼 代碼如下:/**
*Javadoc注釋
*/

當Java源檔案編譯的時候，Javadoc工具會讀取源檔案當中的Javadoc注釋內容，並產生相應的HTML文檔。供開發人員參閱API相關的內容。
在C#中採用了另外一種形式，即XML。
為了能夠在編譯過程中產生XML文檔，需要一種來標記來標註注釋。即三根反斜線。
下面是一個簡單的例子:複製代碼 代碼如下:namespace MyNameSpace
{
/// <summary>
/// 這是一個普通的類
/// </summary>
public class Person
{
/// <summary>
/// 這是標識的ID
/// </summary>
public string Id { get; protected set; }
/// <summary>
/// 這是姓名
/// </summary>
public string Name { get; set; }
/// <summary>
/// 這是年齡
/// </summary>
public int Age { get; set; }

/// <summary>
/// 這是建構函式
/// </summary>
/// <param name="id">ID</param>
/// <param name="name">姓名</param>
/// <param name="age">年齡</param>
public Person(string id, string name, int age)
{
this.Id = id;
this.Name = name;
this.Age = age;
}
/// <summary>
/// 介紹自己啦
/// </summary>
public void IntroduceMyself()
{
Console.WriteLine("My name is {0}, My age is {1}", Name, Age);
}
/// <summary>
/// 計算兩者之和
/// </summary>
/// <param name="a">左運算元</param>
/// <param name="b">右運算元</param>
/// <returns>兩者和</returns>
public int calculate(int a, int b)
{
return a + b;
}
/// <summary>
/// 講話啦
/// </summary>
/// <param name="msg">講的內容</param>
public void saySomething(string msg)
{
Console.WriteLine(msg);
}
}
}

編譯該檔案: csc /doc:test.xml test.cs

查看產生的XML文檔:

複製代碼 代碼如下:<?xml version="1.0"?>
<doc>
<assembly>
<name>MyNameSpace</name>
</assembly>
<members>
<member name="T:MyNameSpace.Person">
<summary>
這是一個普通的類
</summary>
</member>
<member name="M:MyNameSpace.Person.#ctor(System.String,System.String,System.Int32)">
<summary>
這是建構函式
</summary>
<param name="id">ID</param>
<param name="name">姓名</param>
<param name="age">年齡</param>
</member>
<member name="M:MyNameSpace.Person.IntroduceMyself">
<summary>
介紹自己啦
</summary>
</member>
<member name="M:MyNameSpace.Person.calculate(System.Int32,System.Int32)">
<summary>
計算兩者之和
</summary>
<param name="a">左運算元</param>
<param name="b">右運算元</param>
<returns>兩者和</returns>
</member>
<member name="M:MyNameSpace.Person.saySomething(System.String)">
<summary>
講話啦
</summary>
<param name="msg">講的內容</param>
</member>
<member name="P:MyNameSpace.Person.Id">
<summary>
這是標識的ID
</summary>
</member>
<member name="P:MyNameSpace.Person.Name">
<summary>
這是姓名
</summary>
</member>
<member name="P:MyNameSpace.Person.Age">
<summary>
這是年齡
</summary>
</member>
</members>
</doc>

如果是在VISUAL STUDIO，需在項目屬性的產生選項卡中選中產生XML檔案，並指定路徑和檔案名稱。

這樣，當您在使用相應的類或者方法時，我們利用IDE內建的提示工具查看該類或該方法的簡要：