2010-03-01 3 views
3

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

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

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

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

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

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

ответ

0

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

0

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

3

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

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

Смежные вопросы