样式警告警告文档标题必须包含与元素参数列表匹配的参数标记 [英] Style cop warning The documentation header must contain param tags matching the element's parameter list

问题描述

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.

推荐答案

///<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:

///<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>

param标签不应该在摘要中，它必须是单独的。

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

这篇关于样式警告警告文档标题必须包含与元素参数列表匹配的参数标记的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！