.net方法參數註釋編寫實例

主要是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, "");    
             
              //其它代碼
             }
       }

 
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章