C#注释的正确使用方法(Delphi与此类似)

来源:互联网 发布:数据挖掘原理与应用 编辑:程序博客网 时间:2024/06/05 10:53
Coding的时候,常常涉及代码注释,常见的注释包括两类:
   
    1)单行注释。格式:// Comments
   
    2)多行注释。格式:/* Comments… */
   
    C#引入了新的注释,即我们在某个函数前新起一行,输入///,会自动增加格式的注释,这里整理一下可用的XML注释。
   
    XML注释分为一级注释(Primary Tags)和二级注释(Secondary Tags),前者可以单独存在,后者必须包含在一级注释内部。
   
    I 一级注释
   
    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注释;
   
    II 二级注释
   
    1. <c> or <code>主要用于加入代码段;
   
    2. <para>的作用类似HTML中的<p>标记符,就是分段;
   
    3. <pararef>用于引用某个参数;
   
    4. <see>的作用类似<seealso>,可以指示其它的方法;
   
    5. <list>用于生成一个列表;
   
    另外,还可以自定义XML标签。
原创粉丝点击