C#XML文档注释常用节点“summary param returns”等简介

时间:2019-12-30 作者:WilliamChan

C#XML文档注释可分为一级注释(Primary Tags)和二级注释(Secondary Tags),前者可以单独存在,后者必须包含在一级注释内部。

  • 一级注释
    1. <remarks>对类型进行描述,功能类似<summary>,据说建议使用<remarks>;
    2. <summary>对共有类型的类、方法、属性或字段进行注释;
    3. <value>主要用于属性的注释,表示属性的制的含义,可以配合<summary>使用;
    4. <param>用于对方法的参数进行说明,格式:<param name=”param_name”>value</param>;
    5. <returns>用于定义方法的返回值,对于一个方法,输入///后,会自动添加<summary>、<param>列表和<returns>;
    6. <exception>定义可能抛出的异常,格式:<exception cref=”IDNotFoundException”>;
    7. <example>用于给出如何使用某个方法、属性或者字段的使用方法;
    8. <permission>涉及方法的访问许可;
    9. <seealso>用于参考某个其它的东东:),也可以通过cref设置属性;
    10. <include>用于指示外部的XML注释;
  • 二级注释
    1. <c> or <code>主要用于加入代码段;
    2. <para>的作用类似HTML中的<p>标记符,就是让在智能提示时在新行显示(换行)
    3. <pararef>用于引用某个参数;
    4. <see>的作用类似<seealso>,可以指示其它的方法;
    5. <list>用于生成一个列表;

以上就是知道不整理的《C#XML文档注释常用节点“summary param returns”等简介》的所有内容,希望对您有所帮助!

声明:若您对本文内容有任何意见,欢迎发送邮件至:admin@zhidaobu.com,本站会尽快回应并做出相应处理。