Usage of remarks tag in Visual Studio

Source: Internet
Author: User

The <remarks> flag is used to add information about a certain type to supplement the information specified by <summary> ."

The <summary> flag should be used to describe the type or type member. Use <remarks> to add additional information for a type description ."

-- MSDN excerpt.

Is to supplement the <summary> information, usually followed by <summary>. The following code:

/// <Summary>
/// Use the provided function to execute the SQL command and return a record set from the specified connected database
/// </Summary>
/// <Remarks>
/// Example:
/// SqlDataReader r = ExecuteReader (connString, CommandType. StoredProcedure, "PublishOrders", new SqlParameter ("@ prodid", 24 ));
/// </Remarks>
/// <Param name = "connString"> SqlConnection valid SQL connection string </param>
/// <Param name = "primitive type"> statement type: CommandType. Text, CommandType. StoredProcedure </param>
/// <Param name = "plain text"> SQL statement, which can be a stored procedure </param>
/// <Param name = "paramparms"> SqlParameter [] parameter group </param>
/// <Returns> SqlDataReader: record set of execution results </returns>
Public static SqlDataReader ExecuteReader (string connString, CommandType primitive type, string plain text, params SqlParameter [] parallel parms)
{
SqlCommand cmd = new SqlCommand ();
SqlConnection conn = new SqlConnection (connString );
Try
{
Using (conn)
{
PrepareCommand (cmd, conn, null, partition type, plain text, partition type );
SqlDataReader rdr = cmd. ExecuteReader ();
Cmd. Parameters. Clear ();
Return rdr;
}
}
Catch
{
Throw;
}
}

Related Article

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.