Why do you use XML code in c# code like;
/// <summary>
/// Execute a SqlCommand (that returns no resultset) against the database
specified in the connection string
/// using the provided parameters
/// </summary>
/// <remarks>
/// e.g.:
/// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure,
"PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="connectionString">A valid connection string for a
SqlConnection</param>
/// <param name="commandType">The CommandType (stored procedure, text,
etc.)</param>
/// <param name="commandText">The stored procedure name or T-SQL
command</param>
/// <param name="commandParameters">An array of SqlParamters used to execute
the command</param>
/// <returns>An int representing the number of rows affected by the
command</returns>
What do they serve? 4 3786
Its for automatic documentating, you can auto generate docuementing for APIs
and class libraries in various forms by running it thru a style sheet, want
HTML , not a problem. Its a good thing. Use it.
"ozgur develioglu" <oz*************@yahoo.com> wrote in message
news:uw**************@TK2MSFTNGP12.phx.gbl... Why do you use XML code in c# code like; /// <summary>
/// Execute a SqlCommand (that returns no resultset) against the database specified in the connection string
/// using the provided parameters
/// </summary>
/// <remarks>
/// e.g.:
/// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="connectionString">A valid connection string for a SqlConnection</param>
/// <param name="commandType">The CommandType (stored procedure, text, etc.)</param>
/// <param name="commandText">The stored procedure name or T-SQL command</param>
/// <param name="commandParameters">An array of SqlParamters used to
execute the command</param>
/// <returns>An int representing the number of rows affected by the command</returns>
What do they serve?
In addition to what Jack mentioned - check out the free Ndoc utility which
generates MSDN style documentation based on your C# XML comments.
You can find it at: http://ndoc.sourceforge.net/
Cheers,
Wim Hollebrandse
--
Wimdows Components
..NET components - professional, robust and affordable. http://www.wimdows.com
--
"ozgur develioglu" <oz*************@yahoo.com> wrote in message
news:uw**************@TK2MSFTNGP12.phx.gbl... Why do you use XML code in c# code like; /// <summary>
/// Execute a SqlCommand (that returns no resultset) against the database specified in the connection string
/// using the provided parameters
/// </summary>
/// <remarks>
/// e.g.:
/// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="connectionString">A valid connection string for a SqlConnection</param>
/// <param name="commandType">The CommandType (stored procedure, text, etc.)</param>
/// <param name="commandText">The stored procedure name or T-SQL command</param>
/// <param name="commandParameters">An array of SqlParamters used to
execute the command</param>
/// <returns>An int representing the number of rows affected by the command</returns>
What do they serve?
And the most obvious (and quick result) reason...
The VS.NET IDE shows those commend when you use the class and AutoComplete.
You've seen documentation when using a class and pressing "." after it, like
this:
Console.WriteLine(
Well the IDE will use those XML comments to do the same with your code.
-Noah Coad
Microsoft MVP & MCP
"ozgur develioglu" <oz*************@yahoo.com> wrote in message
news:uw**************@TK2MSFTNGP12.phx.gbl... Why do you use XML code in c# code like; /// <summary>
/// Execute a SqlCommand (that returns no resultset) against the database specified in the connection string
/// using the provided parameters
/// </summary>
/// <remarks>
/// e.g.:
/// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="connectionString">A valid connection string for a SqlConnection</param>
/// <param name="commandType">The CommandType (stored procedure, text, etc.)</param>
/// <param name="commandText">The stored procedure name or T-SQL command</param>
/// <param name="commandParameters">An array of SqlParamters used to
execute the command</param>
/// <returns>An int representing the number of rows affected by the command</returns>
What do they serve?
Its called "intellisense".
"Noah Coad [MVP & MCP]" <no**@coad.net> wrote in message
news:#e**************@TK2MSFTNGP10.phx.gbl... And the most obvious (and quick result) reason... The VS.NET IDE shows those commend when you use the class and
AutoComplete. You've seen documentation when using a class and pressing "." after it,
like this: Console.WriteLine( Well the IDE will use those XML comments to do the same with your code.
-Noah Coad Microsoft MVP & MCP
"ozgur develioglu" <oz*************@yahoo.com> wrote in message news:uw**************@TK2MSFTNGP12.phx.gbl... Why do you use XML code in c# code like; /// <summary>
/// Execute a SqlCommand (that returns no resultset) against the
database specified in the connection string
/// using the provided parameters
/// </summary>
/// <remarks>
/// e.g.:
/// int result = ExecuteNonQuery(connString,
CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24));
/// </remarks>
/// <param name="connectionString">A valid connection string for a SqlConnection</param>
/// <param name="commandType">The CommandType (stored procedure, text, etc.)</param>
/// <param name="commandText">The stored procedure name or T-SQL command</param>
/// <param name="commandParameters">An array of SqlParamters used to execute the command</param>
/// <returns>An int representing the number of rows affected by the command</returns>
What do they serve?
This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics |
by: Jonathan Grobe |
last post by:
From: Nigel Perry <nigel@cosc.canterbury.ac.nz>
Newsgroups: news.announce.newgroups,news.groups
Subject: RFD: comp.std.csharp
Date: Tue, 08 Jul 2003 00:26:01 +0000
REQUEST FOR DISCUSSION (RFD)...
|
by: Nicolas |
last post by:
How do I do a RaiseEvent in csharp
I'm ok in VB but csharp confused me a lot.
******* code ********
private FileSystemWatcher watcher = new FileSystemWatcher();
public delegate void...
|
by: light_wt |
last post by:
Hi
I am taking the 2555 class and a lot of the material is over my head. I don't like the MS's book because there is no step-by-step on interacting with the VS.NET
Is there good free resource...
|
by: Azeem M. Suleman |
last post by:
Hello,
I need to use Csharp compiler and an interpretor. In my application user
will use the application and application will write CSharp code on backend.
But now i don't need to reinvent the...
|
by: Peter Smirnov |
last post by:
Sorry for this newbie question but as far as I heard one need at least VisualStudio to develop
CSharp applications. Is this correct?
Are there otherwise some command line tools like javac.exe and...
| |
by: news.microsoft.com |
last post by:
Hi:
I work in Csharp's parser files by LEX/YACC.Now I have only CSharp-lex.l
and CSharp.y file,but they not have CSharp'comment Parse. this is a part of
CSharp-lex.l.
........................
|
by: Karl |
last post by:
Hi all,
I'm reasonably new to csharp so you have to forgive me asking what may
be a stupid question...
As I said, I'm new to CSharp but in VB I was able to click anywhere on
a DataGridView...
|
by: ajitgoel |
last post by:
Hi;
We have a Javascript function which I have been tasked to move to a
CSharp class. This javascript function uses Regular expression
extensively. This function has a string input parameter and...
|
by: Ajit Goel |
last post by:
Hi;
We have a Javascript function which I have been tasked to move to a
CSharp class. This javascript function uses Regular expression
extensively. This function has a string input parameter and...
|
by: =?Utf-8?B?R3JlZw==?= |
last post by:
I''ve been working with a CSharp web-site (and am new to it). I have a
javascript function that accepts variables from my CSharp code. It all works
fine, with the exception of one variable type. I...
|
by: marktang |
last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
| |
by: jinu1996 |
last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
|
by: Hystou |
last post by:
Overview:
Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
|
by: tracyyun |
last post by:
Dear forum friends,
With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
|
by: agi2029 |
last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
|
by: isladogs |
last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM).
In this session, we are pleased to welcome a new...
|
by: conductexam |
last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and...
| |
by: 6302768590 |
last post by:
Hai team
i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated ...
|
by: muto222 |
last post by:
How can i add a mobile payment intergratation into php mysql website.
| |