欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

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

 更新時(shí)間:2012年12月19日 09:18:23   作者:  
在C/C++,JAVA中,有兩種注釋,一種是單行注釋,即兩根反斜杠(//),另一種是多行注釋,即以/*開頭,以*/結(jié)尾,本文將詳細(xì)介紹,需要的朋友可以參考下

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

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

1.普通多行注釋,比如

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

/*
*多行注釋
*/

2.Javadoc注釋,比如
復(fù)制代碼 代碼如下:

/**
*Javadoc注釋
*/

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

namespace MyNameSpace
{
/// <summary>
/// 這是一個(gè)普通的類
/// </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>
/// 講話啦
/// </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è)普通的類
</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>
講話啦
</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>

如果是在VISUAL STUDIO,需在項(xiàng)目屬性的生成選項(xiàng)卡中選中生成XML文件,并指定路徑和文件名。


這樣,當(dāng)您在使用相應(yīng)的類或者方法時(shí),我們利用IDE自帶的提示工具查看該類或該方法的簡(jiǎn)要:


相關(guān)文章

  • c# JSON返回格式的WEB SERVICE

    c# JSON返回格式的WEB SERVICE

    首先用c#創(chuàng)建一個(gè)web service,主要是利用其WSDL的功能,當(dāng)然也可以利用php創(chuàng)建一個(gè),道理都是一樣的
    2008-12-12
  • C#調(diào)用7z實(shí)現(xiàn)文件的壓縮與解壓

    C#調(diào)用7z實(shí)現(xiàn)文件的壓縮與解壓

    這篇文章主要介紹了C#調(diào)用7z實(shí)現(xiàn)文件的壓縮與解壓,幫助大家更好的理解和使用c#,感興趣的朋友可以了解下
    2020-12-12
  • C# Cache緩存讀取的設(shè)置方法

    C# Cache緩存讀取的設(shè)置方法

    這篇文章主要介紹了C# Cache緩存讀取的設(shè)置方法,幫助大家更好的理解和學(xué)習(xí)使用c#,感興趣的朋友可以了解下
    2021-03-03
  • C#讀取xml節(jié)點(diǎn)數(shù)據(jù)方法小結(jié)

    C#讀取xml節(jié)點(diǎn)數(shù)據(jù)方法小結(jié)

    這篇文章主要介紹了C#讀取xml節(jié)點(diǎn)數(shù)據(jù)的方法,實(shí)例總結(jié)了C#針對(duì)XML文件節(jié)點(diǎn)操作的相關(guān)技巧,需要的朋友可以參考下
    2015-06-06
  • 詳解c# 類型轉(zhuǎn)換

    詳解c# 類型轉(zhuǎn)換

    這篇文章主要介紹了c# 類型轉(zhuǎn)換的相關(guān)資料,文中講解非常細(xì)致,代碼幫助大家更好的理解和學(xué)習(xí),感興趣的朋友可以學(xué)習(xí)
    2020-07-07
  • C# wx獲取token的基本方法

    C# wx獲取token的基本方法

    這篇文章主要為大家詳細(xì)介紹了C# wx獲取token的基本方法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2017-06-06
  • C# FileStream讀寫的文本操作代碼分析

    C# FileStream讀寫的文本操作代碼分析

    這篇文章主要分享了個(gè)人使用C# FileStream實(shí)現(xiàn)的讀寫的文本操作的小程序,主要是復(fù)習(xí)下對(duì)filestream的理解,希望對(duì)大家學(xué)習(xí)C#能夠有所幫助
    2016-07-07
  • Unity3d獲取系統(tǒng)時(shí)間

    Unity3d獲取系統(tǒng)時(shí)間

    本文通過一段代碼給大家詳解unity3d獲取系統(tǒng)時(shí)間,代碼簡(jiǎn)單易懂,小伙伴們快來看看吧
    2015-11-11
  • 基于C#實(shí)現(xiàn)哈夫曼樹算法

    基于C#實(shí)現(xiàn)哈夫曼樹算法

    哈夫曼樹又稱最優(yōu)二叉樹,也就是帶權(quán)路徑最短的樹,對(duì)于哈夫曼樹,我想大家對(duì)它是非常的熟悉,使用下面我們就來學(xué)習(xí)一下如何通過C#實(shí)現(xiàn)哈夫曼樹算法吧
    2023-11-11
  • Unity?UGUI的Text文本組件使用示例

    Unity?UGUI的Text文本組件使用示例

    這篇文章主要為大家介紹了Unity?UGUI的Text文本組件使用示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪
    2023-07-07

最新評(píng)論