c#如何使用 XML 文檔功能
下面的示例提供對(duì)某個(gè)已存檔類型的基本概述。
示例
// If compiling from the command line, compile with: -doc:YourFileName.xml /// <summary> /// Class level summary documentation goes here. /// </summary> /// <remarks> /// Longer comments can be associated with a type or member through /// the remarks tag. /// </remarks> public class TestClass : TestInterface { /// <summary> /// Store for the Name property. /// </summary> private string _name = null; /// <summary> /// The class constructor. /// </summary> public TestClass() { // TODO: Add Constructor Logic here. } /// <summary> /// Name property. /// </summary> /// <value> /// A value tag is used to describe the property value. /// </value> public string Name { get { if (_name == null) { throw new System.Exception("Name is null"); } return _name; } } /// <summary> /// Description for SomeMethod. /// </summary> /// <param name="s"> Parameter description for s goes here.</param> /// <seealso cref="System.String"> /// You can use the cref attribute on any tag to reference a type or member /// and the compiler will check that the reference exists. /// </seealso> public void SomeMethod(string s) { } /// <summary> /// Some other method. /// </summary> /// <returns> /// Return values are described through the returns tag. /// </returns> /// <seealso cref="SomeMethod(string)"> /// Notice the use of the cref attribute to reference a specific method. /// </seealso> public int SomeOtherMethod() { return 0; } public int InterfaceMethod(int n) { return n * n; } /// <summary> /// The entry point for the application. /// </summary> /// <param name="args"> A list of command line arguments.</param> static int Main(System.String[] args) { // TODO: Add code to start application here. return 0; } } /// <summary> /// Documentation that describes the interface goes here. /// </summary> /// <remarks> /// Details about the interface go here. /// </remarks> interface TestInterface { /// <summary> /// Documentation that describes the method goes here. /// </summary> /// <param name="n"> /// Parameter n requires an integer argument. /// </param> /// <returns> /// The method returns an integer. /// </returns> int InterfaceMethod(int n); }
該示例生成一個(gè)包含以下內(nèi)容的 .xml 文件。
<?xml version="1.0"?> <doc> <assembly> <name>xmlsample</name> </assembly> <members> <member name="T:TestClass"> <summary> Class level summary documentation goes here. </summary> <remarks> Longer comments can be associated with a type or member through the remarks tag. </remarks> </member> <member name="F:TestClass._name"> <summary> Store for the Name property. </summary> </member> <member name="M:TestClass.#ctor"> <summary> The class constructor. </summary> </member> <member name="P:TestClass.Name"> <summary> Name property. </summary> <value> A value tag is used to describe the property value. </value> </member> <member name="M:TestClass.SomeMethod(System.String)"> <summary> Description for SomeMethod. </summary> <param name="s"> Parameter description for s goes here.</param> <seealso cref="T:System.String"> You can use the cref attribute on any tag to reference a type or member and the compiler will check that the reference exists. </seealso> </member> <member name="M:TestClass.SomeOtherMethod"> <summary> Some other method. </summary> <returns> Return values are described through the returns tag. </returns> <seealso cref="M:TestClass.SomeMethod(System.String)"> Notice the use of the cref attribute to reference a specific method. </seealso> </member> <member name="M:TestClass.Main(System.String[])"> <summary> The entry point for the application. </summary> <param name="args"> A list of command line arguments.</param> </member> <member name="T:TestInterface"> <summary> Documentation that describes the interface goes here. </summary> <remarks> Details about the interface go here. </remarks> </member> <member name="M:TestInterface.InterfaceMethod(System.Int32)"> <summary> Documentation that describes the method goes here. </summary> <param name="n"> Parameter n requires an integer argument. </param> <returns> The method returns an integer. </returns> </member> </members> </doc>
編譯代碼
若要編譯該示例,請(qǐng)輸入以下命令:
csc XMLsample.cs /doc:XMLsample.xml
此命令創(chuàng)建 XML 文件 XMLsample.xml,可在瀏覽器中或使用 TYPE 命令查看該文件。
可靠編程
XML 文檔以 /// 開頭。 創(chuàng)建新項(xiàng)目時(shí),向?qū)?huì)放置一些以 /// 開頭的行。 處理這些注釋時(shí)存在一些限制:
1.文檔必須是格式正確的 XML。 如果 XML 格式不正確,則會(huì)生成警告,并且文檔文件將包含一條注釋,指出遇到錯(cuò)誤。
2.開發(fā)人員可以隨意創(chuàng)建自己的標(biāo)記集。 有一組推薦的標(biāo)記。 部分建議標(biāo)記具有特殊含義:
- <param> 標(biāo)記用于描述參數(shù)。 如果已使用,編譯器會(huì)驗(yàn)證該參數(shù)是否存在,以及文檔是否描述了所有參數(shù)。 如果驗(yàn)證失敗,編譯器會(huì)發(fā)出警告。
- cref 屬性可以附加到任何標(biāo)記,以引用代碼元素。 編譯器驗(yàn)證此代碼元素是否存在。 如果驗(yàn)證失敗,編譯器會(huì)發(fā)出警告。 編譯器在查找 cref 屬性中描述的類型時(shí)會(huì)考慮所有 using 語(yǔ)句。
- <summary> 標(biāo)記由 Visual Studio 中的 IntelliSense 用于顯示有關(guān)某個(gè)類型或成員的附加信息。
備注
XML 文件不提供有關(guān)該類型和成員的完整信息(例如,它不包含任何類型信息)。 若要獲取有關(guān)類型或成員的完整信息,請(qǐng)將文檔文件與對(duì)實(shí)際類型或成員的反射一起使用。
以上就是c#如何使用 XML 文檔功能的詳細(xì)內(nèi)容,更多關(guān)于c# 使用 XML 文檔功能的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
C#編程中使用ref和out關(guān)鍵字來(lái)傳遞數(shù)組對(duì)象的用法
這篇文章主要介紹了C#編程中使用ref和out關(guān)鍵字來(lái)傳遞數(shù)組對(duì)象的用法,在C#中數(shù)組也是對(duì)象可以被傳遞,需要的朋友可以參考下2016-01-01Unity3D舊電視濾鏡shader的實(shí)現(xiàn)示例
這篇文章主要介紹了Unity3D舊電視濾鏡shader的實(shí)現(xiàn)示例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04C#實(shí)現(xiàn)簡(jiǎn)單成績(jī)管理系統(tǒng)的完整步驟
這篇文章主要給大家介紹了關(guān)于C#實(shí)現(xiàn)簡(jiǎn)單成績(jī)管理系統(tǒng)的完整步驟,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者使用C#具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-11-11C# 數(shù)獨(dú)求解算法的實(shí)現(xiàn)
這篇文章主要介紹了C# 數(shù)獨(dú)求解算法的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-01-01