.NET -> c# 注释的正确的使用方法
2012-11-12 16:31
169 查看
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>用于生成一个列表; |
相关文章推荐
- 在C#.NET中,关于<%%>使用方法
- 【转载】[C#/ASP.NET]List<>中Sort()、Find()、FindAll()、Exist()的使用方法
- C#注释的正确使用方法(Delphi与此类似)
- [C#/ASP.NET]List<>中Sort()、Find()、FindAll()、Exist()的使用方法
- [C#/ASP.NET]List<>中Sort()、Find()、FindAll()、Exist()的使用方法
- [C#/ASP.NET]List<>中Sort()、Find()、FindAll()、Exist()的使用方法
- [C#/ASP.NET]List<>中Sort()、Find()、FindAll()、Exist()的使用方法
- 编写高质量代码改善C#程序的157个建议[正确操作字符串、使用默认转型方法、却别对待强制转换与as和is]
- C#类中使用Session的正确方法
- vb.net C# AtlAxGetControl 函数使用方法
- 【原创】开源Math.NET基础数学类库使用(12)C#随机数扩展方法
- url重写:使用C#.NET重写URL方法
- asp.net(c#)开发中的文件上传组件uploadify的使用方法(带进度条)
- C#编译器优化那点事 c# 如果一个对象的值为null,那么它调用扩展方法时为甚么不报错 webAPI 控制器(Controller)太多怎么办? .NET MVC项目设置包含Areas中的页面为默认启动页 (五)Net Core使用静态文件 学习ASP.NET Core Razor 编程系列八——并发处理
- NET C# List泛型集合 使用方法
- 深入理解 c# 第一章 使用扩展方法对 List<Product> 排序
- asp.net mvc 2 简简单单做开发 使用DataContext扩展方法Find<TEntity>(TEntity obj) 遇到的问题
- C# 委托的发展史: .Net 1.x 委托 =>.Net 2.x 匿名方法 => .Net 3.0/3.5 Lambda 表达式
- 【原创】开源Math.NET基础数学类库使用(12)C#随机数扩展方法
- NET C# List泛型集合 使用方法