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

我在控制器中有以下操作方法：

/// <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 });
}

//
///将用户重定向到其默认角色的仪表板。
/// 
/// ???
公共操作结果仪表板（）
{
返回RedirectToAction（“索引”，“仪表板”，新{area=（（用户）用户）.Roles[0].Name}）；
}

---

记录执行重定向（或类似操作）的控制器操作的返回值的常用或可接受的方法是什么？

作为参考，我在对象浏览器中打开了一个.NET Framework DLL并查看了方法签名。如果该方法返回某个值，通常会填写

XML注释。请随意使用它作为指导

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

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

///返回对操作的重定向。

否则，标准似乎是删除“返回”一词，并使用以下内容：

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

///重定向到操作。

在这两种情况下，returns标记中的文本通常是返回的对象类型的逐字字符串。

使用属性。虽然它只是

.netcore

，但它是2020年，例如

[产品响应类型（StatusCodes.Status308PermanentResponseType）]
公共操作结果仪表板（）
{
返回RedirectToAction（“索引”，“仪表板”，新{area=（（用户）用户）.Roles[0].Name}）；
}

添加此属性的更全面的方法是

[HttpGet]
[产品响应类型（typeof（FooDto），StatusCodes.Status200OK）]
[产品响应类型（StatusCodes.Status400BadRequest）]
[产品响应类型（StatusCodes.Status404NotFound）]
公共任务GetFoo（）
{
// ...
}

由于我们有ASP.NET Core 2.1，因此happy path在属性中的详细程度可以降低，并且在编译阶段还可以进行类型检查

[HttpGet]
[产品响应类型（StatusCodes.Status200OK）]
[产品响应类型（StatusCodes.Status400BadRequest）]
[产品响应类型（StatusCodes.Status404NotFound）]
公共任务GetFoo（）
{
// ...
}

问得好！我认为这些评论必须是人类可读的。我总是尝试在MVC控制器操作中以“代表…”的MVC视图、“重定向到…”的操作”、“空响应”、“JSON表示…”开始返回注释。但我不知道这是否是最佳做法。只需删除“返回”部分：）