有代理资源网

热门关键词: 
旗下栏目:C#教程vb.net编程Delphijava编程AndroidIOSSwift易语言其它相关 帮助
您现在的位置:首页 > 软件编程 > C#教程 > 正文

C#注释的一些使用方法浅谈

所属栏目: C#教程 | 发布时间:2017-03-13 14:27:13 | 小编:橙子 | #我要评论#

C# Coding的时候,常常涉及代码注释,常见的注释包括两类:
1)单行注释。格式:// Comments
2)多行注释。格式:/* Comments... */
C#引入了新的XML注释,即我们在某个函数前新起一行,输入///,VS.Net会自动增加XML格式的注释,这里整理一下可用的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标签


热点聚合:c#

看过本文的人还看过

本周热门

关于有代理资源网-版权声明-广告服务-发展历程-常见问题-联系我们- TAG标签-网站地图

本站资源来自互联网收集,仅供用于学习和交流,请勿用于商业用途。如有侵权、不妥之处,请联系站长并出示版权证明以便删除。敬请谅解!
侵权删帖/违法举报/投稿联系邮箱:duomu@vip.qq.com

Copyright © 2014-2018 有代理资源网 版权所有 鄂ICP备14013235号-8  鄂公网安备 42090202000244号  

Ctrl+D 将本页面保存为书签,全面了解最新资讯,方便快捷。