.net方法参数注释编写实例

本文介绍了一个用于获取最新职位信息的Web API方法,该方法允许指定返回的记录数量及排序字段,并提供了一个具体的C#示例来展示如何调用此API。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

<script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> </script>主要是example,code标记等的运用,怕忘了,所以记录一下.
         #region GetLatestJobInfo
         ///<summary>
         ///获取最新的职位信息
         ///</summary>
         ///<example>     
         ///<code>
         ///<font face=">宋体" size="2">
         /// [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(10, "");   
         ///          
         ///           <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 {0} * FROM Job_Position order by {1} 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();

              //获取最新10条信息
              //前一个参数表示获取的记录条数,后一个参数表示排序字段,""表示按dtCreate降序
              DataSet ds = position.GetLatestJobInfo(10, "");    
             
              //其它代码
             }
       }

 
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值