best practices using procedure attributes

  • Thread starter Thread starter Izvra
  • Start date Start date
I

Izvra

I seeking for information about using attributes with class/procedure declarations

I want to get result same as microsoft releases for their components.

For example the method XMLDocument.createAttribute
in object browser of the visual studio describes information of him
description
arguments
and return value.
 
Do you mean somthing like this ?

/// <summary>
/// Update Record to Table
/// <remarks>
/// <para>This Method will not close a Connection when finished if the
Connection was Open when called</para>
/// </remarks>
/// </summary>
/// <param name="dset_Row">valid DataRow from the DataTable that has been
Updated</param>
/// <param name="s_WhereSqlString">Condition Sql-String : WHERE
(something='77')</param>
/// <returns>Amount of Records Effected by Command (should be 1, should
not be 0)</returns>
/// <example>
/// <code>
/// </code>
/// </example>
public int OnCommandUpdateRowfromDataSet(DataRow dset_Row,string
s_WhereSqlString)
{
return 7;
}

Results in nDoc Help file :
Update Record to Table

This Method will not close a Connection when finished if the Connection was
Open when called

public int OnCommandUpdateRowfromDataSet(
DataRow dset_Row,
string s_WhereSqlString
);
Parameters
dset_Row
valid DataRow from the DataTable that has been Updated
s_WhereSqlString
Condition Sql-String : WHERE (something='77')
Return Value
Amount of Records Effected by Command (should be 1, should not be 0)

Example

Hope this helps,

Mark Johnson, Berlin Germany
(e-mail address removed)
 
Back
Top