Формат комментариев по умолчанию для контроллеров ASP.NET MVC - PullRequest
3 голосов
/ 01 марта 2010

Может кто-нибудь объяснить формат для контроллеров ASP.NET MVC? Они выглядят так:

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

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

Почему они не следуют стандартному обозначению C # с тремя слешами иРазметка XML?И почему пустая строка между комментарием и методом?

По моему мнению, это должно было выглядеть примерно так:

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

Ответы [ 3 ]

3 голосов
/ 01 марта 2010

Они написаны для тех, кто пишет код, а не для людей, которые вызывают метод контроллера (вероятно, никто не вызовет его напрямую).

Кроме того, комментарии к документации подразумевают объективность, а /Products/Edit/34 не является формальным описанием - это зависит от маршрута.

0 голосов
/ 01 марта 2010

Я только догадываюсь, но указанный вами формат предназначен не для комментариев, а для встроенной документации. У вас есть возможность изменить шаблоны T4, чтобы получить стиль кодирования, который вы предпочитаете.

0 голосов
/ 01 марта 2010

Полагаю, автор этого комментария не хотел, чтобы он был включен в документацию сборки.

...