C#的XML兩種代碼注釋實(shí)例說(shuō)明

更新時(shí)間：2012年12月19日 09:18:23 作者：

在C/C++,JAVA中，有兩種注釋?zhuān)环N是單行注釋?zhuān)磧筛葱备?//)，另一種是多行注釋?zhuān)匆?*開(kāi)頭，以*/結(jié)尾,本文將詳細(xì)介紹，需要的朋友可以參考下

在C/C++,JAVA中，有兩種注釋?zhuān)环N是單行注釋?zhuān)磧筛葱备?//)，另一種是多行注釋?zhuān)匆?*開(kāi)頭，以*/結(jié)尾。

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

1.普通多行注釋,比如

復(fù)制代碼代碼如下:

/* 
*多行注釋 
*/

2.Javadoc注釋,比如

復(fù)制代碼代碼如下:

/** 
*Javadoc注釋 
*/

當(dāng)Java源文件編譯的時(shí)候，Javadoc工具會(huì)讀取源文件當(dāng)中的Javadoc注釋內(nèi)容，并生成相應(yīng)的HTML文檔。供開(kāi)發(fā)者參閱API相關(guān)的內(nèi)容。
在C#中采用了另外一種形式，即XML。
為了能夠在編譯過(guò)程中生成XML文檔，需要一種來(lái)標(biāo)記來(lái)標(biāo)注注釋。即三根反斜杠。
下面是一個(gè)簡(jiǎn)單的例子:

復(fù)制代碼代碼如下:

namespace MyNameSpace 
{ 
/// <summary> 
/// 這是一個(gè)普通的類(lèi) 
/// </summary> 
public class Person 
{ 
/// <summary> 
/// 這是標(biāo)識(shí)的ID 
/// </summary> 
public string Id { get; protected set; } 
/// <summary> 
/// 這是姓名 
/// </summary> 
public string Name { get; set; } 
/// <summary> 
/// 這是年齡 
/// </summary> 
public int Age { get; set; } 

/// <summary> 
/// 這是構(gòu)造函數(shù) 
/// </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> 
/// 計(jì)算兩者之和 
/// </summary> 
/// <param name="a">左操作數(shù)</param> 
/// <param name="b">右操作數(shù)</param> 
/// <returns>兩者和</returns> 
public int calculate(int a, int b) 
{ 
return a + b; 
} 
/// <summary> 
/// 講話(huà)啦 
/// </summary> 
/// <param name="msg">講的內(nèi)容</param> 
public void saySomething(string msg) 
{ 
Console.WriteLine(msg); 
} 
} 
}

編譯該文件: csc /doc:test.xml test.cs

查看生成的XML文檔:

復(fù)制代碼代碼如下:

<?xml version="1.0"?> 
<doc> 
<assembly> 
<name>MyNameSpace</name> 
</assembly> 
<members> 
<member name="T:MyNameSpace.Person"> 
<summary> 
這是一個(gè)普通的類(lèi) 
</summary> 
</member> 
<member name="M:MyNameSpace.Person.#ctor(System.String,System.String,System.Int32)"> 
<summary> 
這是構(gòu)造函數(shù) 
</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> 
計(jì)算兩者之和 
</summary> 
<param name="a">左操作數(shù)</param> 
<param name="b">右操作數(shù)</param> 
<returns>兩者和</returns> 
</member> 
<member name="M:MyNameSpace.Person.saySomething(System.String)"> 
<summary> 
講話(huà)啦 
</summary> 
<param name="msg">講的內(nèi)容</param> 
</member> 
<member name="P:MyNameSpace.Person.Id"> 
<summary> 
這是標(biāo)識(shí)的ID 
</summary> 
</member> 
<member name="P:MyNameSpace.Person.Name"> 
<summary> 
這是姓名 
</summary> 
</member> 
<member name="P:MyNameSpace.Person.Age"> 
<summary> 
這是年齡 
</summary> 
</member> 
</members> 
</doc>