Per una determinata classe, dove dovrebbero andare i commenti sullo scopo della classe?
/// <summary>
/// <----------------- describe the class here (1)?
/// </summary>
public class Message
{
...
//class members here
...
/// <summary>
/// <--------------- or here (2)?
/// </summary>
public Message()
{
}
}
Se vado con la prima opzione, lo scopo della classe è molto facile da trovare quando apro il file, è nello stesso posto, approssimativamente sulla stessa riga. Quando hai molte classi, questo è più facile per gli occhi. Non devi scorrere verso il basso oltre i membri per trovare il costruttore
Se vado con la seconda opzione, ottengo Intellisense quando creo un oggetto della classe, affermando il suo scopo e spiegando i parametri, che è molto bello.
Da quello che posso dire, non posso ottenere entrambi i vantaggi usando un solo metodo. L'unica soluzione che riesco a pensare è mettere lo stesso commento in entrambi i posti, ma sono solo informazioni duplicate e non mi piace.