知识大全 .net方法参数注释编写实例

Posted

篇首语:忧劳可以兴国,逸豫可以亡身。。本文由小常识网(cha138.com)小编为大家整理,主要介绍了知识大全 .net方法参数注释编写实例相关的知识,希望对你有一定的参考价值。

        主要是example code标记等的运用 怕忘了 所以记录一下          #region GetLatestJobInfo          ///<summary>          ///获取最新的职位信息          ///</summary>          ///<example>               ///<code>          ///<font face= >宋体 size= >          /// [C#]          /// public class MyClass          ///          ///      public void myMethod()          ///               ///           <font color= green >//创建web service对象</font>          ///           wsJobPosition position = new wsJobPosition();          ///                    ///           <font color= green >//获取最新条信息</font>          ///           <font color= green >//前一个参数表示获取的记录条数 后一个参数表示排序字段 表示按dtCreate降序</font>          ///           DataSet ds = position GetLatestJobInfo( );             ///                    ///           <font color= green >//其它代码</font>          ///               ///           ///           ///</font>           ///</code>          ///</example>          ///<param name= topNumber >显示最新条数</param>          ///<param name= orderField >降序排列的字段 默认为dtCreate</param>          ///<returns>返回某字段降序排列的前N条记录</returns>          [WebMethod]            public DataSet GetLatestJobInfo(int topNumber string orderField)                        DataSet ds = new DataSet();               DataTable dt;                 orderField = orderField == ? dtCreate : orderField;                 string sql = SELECT TOP * FROM Job_Position order by desc ;               sql = string Format(sql topNumber orderField);                 dt = clsFactory Create() GetDataTable(sql);               ds Tables Add(dt);                          return ds;                   #endregion        用NDoc生成的说明如下: 

  获取最新的职位信息

  public DataSet GetLatestJobInfo(       int topNumber        string orderField       );

  参数       topNumber            显示最新条数        orderField            降序排列的字段 默认为dtCreate

  返回值           返回某字段降序排列的前N条记录

  示例

  [C#]       public class MyClass                    public void myMethod()                           //创建web service对象              wsJobPosition position = new wsJobPosition();

cha138/Article/program/net/201311/12327

相关参考

知识大全 .net页面间的参数传递简单实例

  使用QueryString  使用QuerySting在页面间传递值已经是一种很老的机制了这种方法的主要优点是实现起来非常简单然而它的缺点是传递的值是会显示在浏览器的地址栏上的(不安全)同时又不能

知识大全 用ASP.Net和Access编写留言本

实例编程:用ASP.Net和Access编写留言本  以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧!用

知识大全 JBuilder2005创建开发文档之编写注释

JBuilder2005创建开发文档之编写注释  以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧!  可

知识大全 PHP注释实例应用

PHPWeb开发学习实录:PHP注释实例应用  以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧!  &n

知识大全 PHP注释实例描述

PHPWeb开发学习实录:PHP注释实例描述  以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧!  &n

知识大全 PHP注释实例分析

PHPWeb开发学习实录:PHP注释实例分析  以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧!  &n

知识大全 两个很详细的shell 实例代码

两个很详细的shell实例一般编程步骤  现在我们来讨论编写一个脚本的一般步骤任何优秀的脚本都应该具有帮助和输入参数并且写一个伪脚本(frameworksh)该脚本包含了大多数脚本都需要的框架结构是一

知识大全 .net编程之路(四)

  现在我们来看看这段代码  如果创建这样的一个实例carMyCar=newcar(mazida)  那么这个实例调用的构造函数是初始化器转向执行带两个参数的构造函数  只读字段  readonly字

知识大全 ASP.NET 登陆代码注释

ASP.NET登陆代码注释  以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧!  ///<summ

知识大全 开发手记:共享软件注册程序编写实例(2)

  OptionExplicit    PrivateDeclareFunctionGetVolumeInformationLibkernel_    AliasGetVolumeInformatio