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

主要是examplecode標記等的運用怕忘了所以記錄一下

 #region GetLatestJobInfo
 ///<summary>
 ///獲取最新的職位信息
 ///</summary>
 ///<example>
 ///<code>
 ///宋體 size=>
 /// [C#]
 /// public class MyClass
 /// {
 /// public void myMethod()
 /// {
 /// //創建web service對象
 /// wsJobPosition position = new wsJobPosition();
 ///
 /// //獲取最新條信息
 /// //前一個參數表示獲取的記錄條數後一個參數表示排序字段表示按dtCreate降序
 /// DataSet ds = positionGetLatestJobInfo( );
 ///
 /// //其它代碼
 /// }
 /// }
 ///
 ///
 ///</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 = stringFormat(sql topNumber orderField);

 dt = clsFactoryCreate()GetDataTable(sql);
 dsTablesAdd(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();

　　//獲取最新條信息
              //前一個參數表示獲取的記錄條數後一個參數表示排序字段表示按dtCreate降序
              DataSet ds = positionGetLatestJobInfo( );

              //其它代碼
             }
       }

From:http://tw.wingwit.com/Article/program/net/201311/12327.html