科技行者

行者学院 转型私董会 科技行者专题报道 网红大战科技行者

知识库

知识库 安全导航

至顶网›软件频道 ›.net方法参数注释编写实例

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

  • 扫一扫
    分享文章到微信

  • 扫一扫
    关注官方公众号
    至顶头条

　　 主要是example,code标记等的运用,怕忘了,所以记录一下. #region GetLatestJobInfo /// ///获取最新的职位信息

作者：builder.com.cn 2007年9月29日

关键字： 参数 方法 编程

  • 评论
  • 分享微博
  • 分享邮件
　　
        主要是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, "");    
             
              //其它代码
             }
       }-

查看本文来源

    • 评论
    • 分享微博
    • 分享邮件
    VIP专区
    邮件订阅

    如果您非常迫切的想了解IT领域最新产品与技术信息，那么订阅至顶网技术邮件将是您的最佳途径之一。

    重磅专题
    往期文章
    最新文章

    业界热点:

    北京第二十六维信息技术有限公司（至顶网）版权所有. 京ICP备15039648号-7 京ICP证161336号 京公网安备 11010802021500号