Click here to Skip to main content
15,914,924 members
Please Sign up or sign in to vote.
0.00/5 (No votes)
See more:
XML
I am Running style cop to reach coding standards in following code I am getting the warning mentioned at last can any one help me in this, thank you

///<summary>
///To to get the tenant information from Ajax function for Update Tenant
///<param name="tenantID">string type tenantID parameter</param>
///</summary>
///<returns>Returns the status object.</returns>
public ActionResult DeleteTenant(string tenantID)
{
bool status=false;
//some functionality
return this.Json(status,JsonRequestBehavior.AllowGet);
}

Warning 34 SA1611:CSharp.Documentation : The documentation header must contain param tags matching the element's parameter list.
Posted

1 solution

C#
///<summary>
///To to get the tenant information from Ajax function for Update Tenant
///<param name="tenantID">string type tenantID parameter</param>
///</summary>
///<returns>Returns the status object.</returns>


Should be:

C#
///<summary>
///To to get the tenant information from Ajax function for Update Tenant
///</summary>
///<param name="tenantID">string type tenantID parameter</param>
///<returns>Returns the status object.</returns>


The param tag should not be inside the summary, it needs to be by itself.
 
Share this answer
 

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)



CodeProject, 20 Bay Street, 11th Floor Toronto, Ontario, Canada M5J 2N8 +1 (416) 849-8900