c# - 记录 ActionResult 返回值的可接受方式

Question

我在 Controller 中有以下操作方法:

/// <summary>
/// Redirects the user to the Dashboard for their default role.
/// </summary>
/// <returns>???</returns>
public ActionResult Dashboard()
{
    return RedirectToAction("Index", "Dashboard", new { area = ((User)User).Roles[0].Name });
}

记录执行重定向(或类似操作)的 Controller 操作的返回值的常见或可接受的方法是什么？

Answer 1

作为引用，我在对象浏览器中打开了一个 .NET Framework DLL 并查看了方法签名。如果该方法返回一些值，通常是 <returns>已填写 XML 注释。请随意将其用作指南。

如果您必须处理非常严格的代码分析或 StyleCop 独裁者，我建议如下:

/// <returns>Returns a redirect to an action.</returns>

否则，规范似乎是删除“返回”一词并使用类似以下内容:

/// <returns>A redirect to an action.</returns>

无论哪种情况，返回标记中的文本通常都是返回对象类型的逐字字符串。