C#注釋的一些使用方法淺談
更新時間：2013年04月26日 15:20:32 作者：
C#注釋的一些使用方法淺談，需要的朋友可以參考一下
C# Coding的時候，常常涉及代碼注釋，常見的注釋包括兩類：
1）單行注釋。格式：// Comments
2）多行注釋。格式：/* Comments... */
C#引入了新的XML注釋，即我們在某個函數(shù)前新起一行，輸入///，VS.Net會自動增加XML格式的注釋，這里整理一下可用的XML注釋。
XML注釋分為一級注釋（Primary Tags）和二級注釋（Secondary Tags），前者可以單獨存在，后者必須包含在一級注釋內(nèi)部。
I 一級注釋
1. <remarks>對類型進行描述，功能類似<summary>，據(jù)說建議使用<remarks>;
2. <summary>對共有類型的類、方法、屬性或字段進行注釋；
3. <value>主要用于屬性的注釋，表示屬性的制的含義，可以配合<summary>使用；
4. <param>用于對方法的參數(shù)進行說明，格式：<param name="param_name">value</param>；
5. <returns>用于定義方法的返回值，對于一個方法，輸入///后，會自動添加<summary>、<param>列表和<returns>；
6. <exception>定義可能拋出的異常，格式：<exception cref="IDNotFoundException">；
7. <example>用于給出如何使用某個方法、屬性或者字段的使用方法；
8. <permission>涉及方法的訪問許可；
9. <seealso>用于參考某個其它的東東:)，也可以通過cref設(shè)置屬性；
10. <include>用于指示外部的XML注釋；
II 二級注釋
1. <c> or <code>主要用于加入代碼段；
2. <para>的作用類似HTML中的<p>標記符，就是分段；
3. <pararef>用于引用某個參數(shù)；
4. <see>的作用類似<seealso>，可以指示其它的方法；
5. <list>用于生成一個列表；
另外，還可以自定義XML標簽
1）單行注釋。格式：// Comments
2）多行注釋。格式：/* Comments... */
C#引入了新的XML注釋，即我們在某個函數(shù)前新起一行，輸入///，VS.Net會自動增加XML格式的注釋，這里整理一下可用的XML注釋。
XML注釋分為一級注釋（Primary Tags）和二級注釋（Secondary Tags），前者可以單獨存在，后者必須包含在一級注釋內(nèi)部。
I 一級注釋
1. <remarks>對類型進行描述，功能類似<summary>，據(jù)說建議使用<remarks>;
2. <summary>對共有類型的類、方法、屬性或字段進行注釋；
3. <value>主要用于屬性的注釋，表示屬性的制的含義，可以配合<summary>使用；
4. <param>用于對方法的參數(shù)進行說明，格式：<param name="param_name">value</param>；
5. <returns>用于定義方法的返回值，對于一個方法，輸入///后，會自動添加<summary>、<param>列表和<returns>；
6. <exception>定義可能拋出的異常，格式：<exception cref="IDNotFoundException">；
7. <example>用于給出如何使用某個方法、屬性或者字段的使用方法；
8. <permission>涉及方法的訪問許可；
9. <seealso>用于參考某個其它的東東:)，也可以通過cref設(shè)置屬性；
10. <include>用于指示外部的XML注釋；
II 二級注釋
1. <c> or <code>主要用于加入代碼段；
2. <para>的作用類似HTML中的<p>標記符，就是分段；
3. <pararef>用于引用某個參數(shù)；
4. <see>的作用類似<seealso>，可以指示其它的方法；
5. <list>用于生成一個列表；
另外，還可以自定義XML標簽
相關(guān)文章
JSON采用完全獨立于語言的文本格式,但是也使用了類似于C語言家族的習慣（包括C, C++, C#, Java, JavaScript, Perl, Python等）,下面這篇文章主要給大家介紹了關(guān)于C#讀寫JSON文件詳盡代碼示例與注釋解析的相關(guān)資料,需要的朋友可以參考下2024-06-06
這篇文章介紹了c#初學簡單程序?qū)嵗a，有需要的朋友可以參考一下2013-10-10
這篇文章主要為大家詳細介紹了WPF實現(xiàn)手風琴式輪播圖切換效果，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2020-09-09
is模式匹配操作符通過測試一個變量是否是一個對象,來判斷其是否不為null值，本文主要介紹了C#8.0中新語法“is{}“的介紹及使用小結(jié)，感興趣的可以了解一下2023-11-11
本文將介紹C#日期格式化的幾個要點,包括標準 DateTime 格式字符串。希望大家能從中得到更多的理解和幫助2013-09-09
c#編程中經(jīng)常有遇到要處理文件路徑的需求，本文分別講述了如何從程序下面的文件和臨時目錄下的文件去使用路徑api，感興趣的朋友可以了解下2021-05-05
這篇文章主要為大家介紹了C#實現(xiàn)接口base調(diào)用示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-06-06
NPOI中N指代的是.Net，POI是一個完全開源的Java寫成的庫，能夠在沒有安裝微軟Office或者相應環(huán)境的情況下讀寫Excel、Word等微軟OLE2組件文檔，幾乎支持所有的Office97~Office2007的文件格式。所以NPOI就是POI項目的.Net版本。2017-05-05
這篇文章主要介紹了使用C#獲取條碼槍的返回值,實現(xiàn)了獲取條碼信息、條碼是否有效、掃描時間、掃描碼等參數(shù)2014-01-01
這篇文章主要介紹了C#使用迭代法實現(xiàn)Fibnaci數(shù)列的方法,較為詳細的分析了Fibnaci數(shù)列的原理與迭代法實現(xiàn)技巧,需要的朋友可以參考下2015-05-05