C# XML 註解說明

  • 1277
  • 0
  • C#
  • 2023-05-11

C# XML 註解說明

XML 註解分為一級註解(Primary Tags)和二級註解(Secondary Tags),前者可以單獨存在,後者必須包含在一級註解內。

一級註解

<remarks>    對類型進行描述,功能類似<summary>,據說建議使用<remarks>;
<summary>    對共有類型的類、方法、屬性或字段進行註解;
<value>      主要用於屬性的註解,表示屬性的制的含義,可以配合<summary>使用;
<param>      用於對方法的參數進行說明,格式:<param name="param_name">value</param>;
<returns>    用於定義方法的返回值,對於一個方法,輸入///後,會自動添加<summary>、<param>列表和<returns>;
<exception>  定義可能拋出的異常,格式:<exception cref="IDNotFoundException">;
<example>    用於給出如何使用某個方法、屬性或者字段的使用方法;
<permission> 涉及方法的訪問許可;
<seealso>    用於參考某個其它的東東:),也可以通過cref設置屬性;
<include>    用於指示外部的XML註解;


二級註解

<c> 或 <code> 主要用於加入代碼段;
<para>        的作用類似HTML中的<p>標記符,就是分段;
<pararef>     用於引用某個參數;
<see>         作用類似<seealso>,可以指示其它的方法;
<list>        用於產生一個列表;

程式是運氣與直覺堆砌而成的奇蹟。
若不具備這兩者,不可能以這樣的工時實現這樣的規格。
修改規格是對奇蹟吐槽的褻瀆行為。
而追加修改則是相信奇蹟還會重現的魯莽行動。