麻豆小视频在线观看_中文黄色一级片_久久久成人精品_成片免费观看视频大全_午夜精品久久久久久久99热浪潮_成人一区二区三区四区

首頁 > 編程 > C# > 正文

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

2020-01-24 03:37:13
字體:
供稿:網(wǎng)友

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

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

1.普通多行注釋,比如

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

/*
*多行注釋
*/

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

/**
*Javadoc注釋
*/

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

namespace MyNameSpace
{
/// <summary>
/// 這是一個(gè)普通的類
/// </summary>
public class Person
{
/// <summary>
/// 這是標(biāo)識的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)識的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自帶的提示工具查看該類或該方法的簡要:


發(fā)表評論 共有條評論
用戶名: 密碼:
驗(yàn)證碼: 匿名發(fā)表
主站蜘蛛池模板: 久久久久久久久久久久免费 | 国产成人精品一区二区仙踪林 | 久久网站热最新地址4 | 黄色片一区二区 | 特级黄aaaaaaaaa毛片 | 深夜福利视频绿巨人视频在线观看 | 国产乱淫av | 精品一区二区三区日本 | 欧美一区二区三区免费不卡 | 亚洲性生活免费视频 | www.99久| freexxx69性欧美hd | 久久国产精品99久久人人澡 | 欧美性生活久久久 | 天天看成人免费毛片视频 | 成年人观看免费视频 | 国产精品久久久久久久久久iiiii | 国产精品一区二区x88av | 宅男噜噜噜66国产在线观看 | 九九精品视频免费 | 黄色一级片免费在线观看 | 新久草在线视频 | 黄色片网站免费观看 | 伊人在线| 黄色淫片 | 亚洲日本韩国在线观看 | 国产成人在线视频播放 | 成人福利软件 | 色妞欧美| 成人 精品| 久久久三区 | 久久毛片免费观看 | 羞羞的视频在线观看 | 7777久久香蕉成人影院 | 最新午夜综合福利视频 | 国产羞羞视频在线免费观看 | 综合97 | 久久视讯 | 欧美成人精品一区二区三区 | 日日草夜夜| 天天看夜夜爽 |