首页
网页制作
网络编程
脚本专栏
数据库
网站运营
网络安全
平面设计
CMS教程
搜索
建站极客
软件编程
C#教程
正文
C#注释的一些使用方法浅谈
所属分类:
软件编程
/
C#教程
阅读数: 126
收藏 0
赞 0
分享
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# 大小写转换(金额)实例代码
C# 大小写转换(金额)实例代码,需要的朋友可以参考一下
评论 0
收藏 0
赞 0
分享
C# WinForm中Panel实现用鼠标操作滚动条的实例方法
由于在WinForm中Panel不能直接响应鼠标的滚动事件,只好采用捕获窗体的滚动事件。
评论 0
收藏 0
赞 0
分享
C#访问应用程序配置文件的方法
C#访问应用程序配置文件的方法,需要的朋友可以参考一下
评论 0
收藏 0
赞 0
分享
C#读写文件的方法汇总
C#读写文件的方法汇总,需要的朋友可以参考一下
评论 0
收藏 0
赞 0
分享
C#计算代码执行时间的方法
在一些测试工作时我们需要获得高精度的代码执行时间以比较其效率。
评论 0
收藏 0
赞 0
分享
C# 动画窗体(AnimateWindow)的小例子
C# 动画窗体(AnimateWindow)的小例子,需要的朋友可以参考一下
评论 0
收藏 0
赞 0
分享
C# zxing二维码写入的实例代码
C# zxing二维码写入的实例代码,需要的朋友可以参考一下
评论 0
收藏 0
赞 0
分享
c#判断输入的是不是数字的小例子
c#判断输入的是不是数字的小例子,需要的朋友可以参考一下
评论 0
收藏 0
赞 0
分享
c# 深拷贝与浅拷贝的区别分析及实例
浅拷贝(影子克隆):只复制对象的基本类型,对象类型,仍属于原来的引用. 深拷贝(深度克隆):不紧复制对象的基本类,同时也复制原对象中的对象.就是说完全是新对象产生的.
评论 0
收藏 0
赞 0
分享
C#利用com操作excel释放进程的解决方法
最近利用Microsoft.Office.Interop.Excel.Application读取一个excel后,进程中一直存在excel,在网上找了一阵子,其中有几个解决方案
评论 0
收藏 0
赞 0
分享
查看更多
网络赚钱
更多
朋友圈疯传的万能Wi-Fi账号是假的 犯了常识性错误
Google
adsense西联邮局收款两张版本单子填写示例
谷歌广告怎么收款?光大银行需要携带资料到柜台办理
Google AdSense 电汇教程 谷歌联盟国内电汇收款教程(招行)
网站如何靠SEO盈利?先把网站包装成专卖店吧
站长故事
更多
喜马拉雅创始人自述:网络电台一年半获取7000万用户
2014,回顾互联网公司招聘的那些奇葩故事
奇幻咔咔3D小熊孟得明 揭秘瞬间火爆网络的背后故事
一个大学生自述:我是如何把公司做死的
站长做好以下三个步骤 长期盈利不是难事
网站SEO反面案例 7万RMB建设的企业网站哪里出了问题?