C#的XML兩種代碼註釋實例說明參數註解 summary param name

出處：http://www.jb51.net/article/32695.htm

在C/C++,JAVA中，有兩種註釋，一種是單行註釋，即兩根反斜槓(//)，另一種是多行註釋，即以/*開頭，以*/結尾,本文將詳細介紹，需要的朋友可以參考下

在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自帶的提示工具查看該類或該方法的簡要：

相關推薦