Visual Studio中remarks標記的用法

      “<remarks> 標記用於添加有關某個類型的資訊，從而補充由 <summary> 所指定的資訊。”

      “<summary> 標記應當用於描述類型或類型成員。使用 <remarks> 添加針對某個類型說明的補充資訊。”

——MSDN摘錄。

      就是對<summary>的資訊的補充，通常緊跟在<summary>的後面。如下代碼：

        /// <summary>
        /// 用提供的函數，執行SQL命令，返回一個從指定串連的資料庫記錄集
        /// </summary>
        ///<remarks>
        ///例如：
        ///SqlDataReader r=ExecuteReader(connString, CommandType.StoredProcedure,"PublishOrders",new SqlParameter("@prodid",24));
        /// </remarks>
        /// <param name="connString">SqlConnection有效SQL連接字串</param>
        /// <param name="cmdType">語句類型：CommandType.Text、CommandType.StoredProcedure</param>
        /// <param name="cmdText">SQL語句，可以為預存程序</param>
        /// <param name="cmdParms">SqlParameter[]參數組</param>
        /// <returns>SqlDataReader：執行結果的記錄集</returns>
        public static SqlDataReader ExecuteReader(string connString, CommandType cmdType, string cmdText,params SqlParameter[] cmdParms)
        {
            SqlCommand cmd = new SqlCommand();
            SqlConnection conn = new SqlConnection(connString);
            try
            {
                using (conn)
                {
                    PrepareCommand(cmd, conn, null, cmdType, cmdText, cmdType);
                    SqlDataReader rdr = cmd.ExecuteReader();
                    cmd.Parameters.Clear();
                    return rdr;
                }
            }
            catch
            {
                throw;
            }
        }