2010-03-04 5 views
0

Y a-t-il un point dans l'écriture de commentaires dans un code comme celui-ci?Y at-il un point dans l'écriture du type de membre d'une classe pour chaque membre de la classe?

/// <Remarks> 
/// Name of abc - public property. 
/// </Remarks> 

Dans Visual Studio, l'IntelliSense a des icônes pour chaque type de membre de classe (sur le terrain, propriété, etc.), donc je ne vois pas le point de cela. Dans mon magasin actuel, nous n'utilisons que Visual Studio, qui fournit ces icônes.

Merci

+0

DRY, YAGNI. (Pas exactement DRY, mais * très * proche et dans le même esprit.) –

Répondre

1

Cela me semble assez inutile. Je l'éviterais, parce que, comme vous le dites, c'est quelque chose qui peut être déduit du code, trivialement. (edit: FWIW, peut-être il est utile pour certains outils que votre organisation exécute de faire de la documentation, et l'outil n'est pas assez intelligent pour détecter les propriétés par rapport aux champs, mais je doute que ce soit le cas. encoder les données 'redondantes' dans les commentaires (pour satisfaire un outil (humain ou pas: P))

+0

C'était un Ce qui m'a fait rire, c'est qu'un codeur ayant moins d 'expérience (moins d' expérience de travail sans âge) recevait son code commenté alors que cela devrait être son propre devoir? un document donc ce que j'ai dit aurait été bien, vraiment étrange. – dotnetdev

Questions connexes