Question

有人可以解释ASP.NET MVC控制器的格式吗？他们看起来像这样：

public class ProductsController : Controller
{
    //
    // GET: /Products/Edit/34

    public ActionResult Edit(int id)
    {
        // ...
    }
}

为什么它们不遵循带有三个斜杠和XML标记的标准C＃-notation？为什么注释和方法之间的空行？

我的意见应该看起来有点像这样：

public class ProductsController : Controller
{
    /// <remarks>
    /// GET: /Products/Edit/34
    /// </remarks>
    public ActionResult Edit(int id)
    {
        // ...
    }
}

Answer 1

这些是为编写代码的人编写的，而不是为调用控制器方法的人编写的（可能没有人会直接调用它）。

此外，文档评论意味着客观性，/Products/Edit/34不是正式描述 - 它取决于路线。

Answer 2

我想这篇评论的作者不希望它被包含在程序集的文档中。

Answer 3

我只是猜测，但您指定的格式不是用于评论，而是用于内联文档。您可以修改T4模板以获得您喜欢的编码样式。

ASP.NET MVC控制器的注释的默认格式

3 个答案: