2010-03-01 4 views
3

Quelqu'un peut-il expliquer le format des automates ASP.NET MVC? Ils ressemblent à ceci:Format par défaut des commentaires pour les contrôleurs ASP.NET MVC

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

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

Pourquoi ne pas suivre la norme C# -notation avec trois barres obliques et des balises XML? Et pourquoi la ligne vide entre le commentaire et la méthode?

Je mon oppinion il aurait dû regarder un peu comme ceci:

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

Répondre

0

Je ne fais que deviner, mais le format que vous avez spécifié n'est pas pour les commentaires, mais pour la documentation en ligne. Vous avez la possibilité de modifier les modèles T4 pour obtenir le style de codage que vous préférez.

0

Je suppose que l'auteur de ce commentaire ne voulait pas qu'il soit inclus dans la documentation de l'assemblée.

3

Ceux-ci sont écrits pour la personne qui écrit le code, et non pour les personnes qui appellent la méthode du contrôleur (probablement personne ne l'appellera directement de toute façon).

De plus, les commentaires de documentation impliquent de l'objectivité et /Products/Edit/34 n'est pas une description formelle - cela dépend de l'itinéraire.

Questions connexes