C#注釋的一些使用方法淺談
更新時(shí)間：2013年04月26日 15:20:32 作者：
C#注釋的一些使用方法淺談，需要的朋友可以參考一下
C# Coding的時(shí)候，常常涉及代碼注釋，常見的注釋包括兩類：
1）單行注釋。格式：// Comments
2）多行注釋。格式：/* Comments... */
C#引入了新的XML注釋，即我們在某個(gè)函數(shù)前新起一行，輸入///，VS.Net會(huì)自動(dòng)增加XML格式的注釋，這里整理一下可用的XML注釋。
XML注釋分為一級(jí)注釋（Primary Tags）和二級(jí)注釋（Secondary Tags），前者可以單獨(dú)存在，后者必須包含在一級(jí)注釋內(nèi)部。
I 一級(jí)注釋
1. <remarks>對(duì)類型進(jìn)行描述，功能類似<summary>，據(jù)說建議使用<remarks>;
2. <summary>對(duì)共有類型的類、方法、屬性或字段進(jìn)行注釋；
3. <value>主要用于屬性的注釋，表示屬性的制的含義，可以配合<summary>使用；
4. <param>用于對(duì)方法的參數(shù)進(jìn)行說明，格式：<param name="param_name">value</param>；
5. <returns>用于定義方法的返回值，對(duì)于一個(gè)方法，輸入///后，會(huì)自動(dòng)添加<summary>、<param>列表和<returns>；
6. <exception>定義可能拋出的異常，格式：<exception cref="IDNotFoundException">；
7. <example>用于給出如何使用某個(gè)方法、屬性或者字段的使用方法；
8. <permission>涉及方法的訪問許可；
9. <seealso>用于參考某個(gè)其它的東東:)，也可以通過cref設(shè)置屬性；
10. <include>用于指示外部的XML注釋；
II 二級(jí)注釋
1. <c> or <code>主要用于加入代碼段；
2. <para>的作用類似HTML中的<p>標(biāo)記符，就是分段；
3. <pararef>用于引用某個(gè)參數(shù)；
4. <see>的作用類似<seealso>，可以指示其它的方法；
5. <list>用于生成一個(gè)列表；
另外，還可以自定義XML標(biāo)簽
1）單行注釋。格式：// Comments
2）多行注釋。格式：/* Comments... */
C#引入了新的XML注釋，即我們在某個(gè)函數(shù)前新起一行，輸入///，VS.Net會(huì)自動(dòng)增加XML格式的注釋，這里整理一下可用的XML注釋。
XML注釋分為一級(jí)注釋（Primary Tags）和二級(jí)注釋（Secondary Tags），前者可以單獨(dú)存在，后者必須包含在一級(jí)注釋內(nèi)部。
I 一級(jí)注釋
1. <remarks>對(duì)類型進(jìn)行描述，功能類似<summary>，據(jù)說建議使用<remarks>;
2. <summary>對(duì)共有類型的類、方法、屬性或字段進(jìn)行注釋；
3. <value>主要用于屬性的注釋，表示屬性的制的含義，可以配合<summary>使用；
4. <param>用于對(duì)方法的參數(shù)進(jìn)行說明，格式：<param name="param_name">value</param>；
5. <returns>用于定義方法的返回值，對(duì)于一個(gè)方法，輸入///后，會(huì)自動(dòng)添加<summary>、<param>列表和<returns>；
6. <exception>定義可能拋出的異常，格式：<exception cref="IDNotFoundException">；
7. <example>用于給出如何使用某個(gè)方法、屬性或者字段的使用方法；
8. <permission>涉及方法的訪問許可；
9. <seealso>用于參考某個(gè)其它的東東:)，也可以通過cref設(shè)置屬性；
10. <include>用于指示外部的XML注釋；
II 二級(jí)注釋
1. <c> or <code>主要用于加入代碼段；
2. <para>的作用類似HTML中的<p>標(biāo)記符，就是分段；
3. <pararef>用于引用某個(gè)參數(shù)；
4. <see>的作用類似<seealso>，可以指示其它的方法；
5. <list>用于生成一個(gè)列表；
另外，還可以自定義XML標(biāo)簽
相關(guān)文章
本篇文章主要介紹了關(guān)于for循環(huán)的經(jīng)典案例，具有很好的參考價(jià)值。下面跟著小編一起來看下吧2017-05-05
C#利用反射技術(shù)實(shí)現(xiàn)去掉按鈕選中時(shí)的邊框效果
這篇文章主要介紹了C#利用反射技術(shù)實(shí)現(xiàn)去掉按鈕選中時(shí)的邊框效果,涉及C#針對(duì)窗口的參數(shù)設(shè)置技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-09-09
這篇文章主要為大家詳細(xì)介紹了WPF實(shí)現(xiàn)半圓形導(dǎo)航菜單，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-08-08
這篇文章主要為大家詳細(xì)介紹了C#端口掃描器的編寫方法，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-07-07
C#中GraphicsPath的Widen方法用法實(shí)例
這篇文章主要介紹了C#中GraphicsPath的Widen方法用法,實(shí)例分析了Widen方法的使用技巧,需要的朋友可以參考下2015-06-06
C#獲取每個(gè)年,月,周的起始日期和結(jié)束日期的方法
這篇文章主要介紹了C#獲取每個(gè)年,月,周的起始日期和結(jié)束日期的方法,涉及C#時(shí)間與日期基本操作技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2017-02-02
這篇文章主要介紹了c# 向MySQL添加數(shù)據(jù)的兩種方法，幫助大家更好的理解和學(xué)習(xí)使用c#，感興趣的朋友可以了解下2021-03-03
本文主要介紹了C#中可空類型的使用，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
這篇文章主要介紹了C# WebApi 路由機(jī)制剖析,小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-07-07
這篇文章主要為大家詳細(xì)介紹了C#實(shí)現(xiàn)控制臺(tái)飛行棋小游戲，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下的相關(guān)資料2021-07-07