Estou procurando uma recomendação de uma prática recomendada para comentários XML em C #. Quando você cria uma propriedade, parece que a documentação XML esperada possui o seguinte formato:
/// <summary>
/// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance.
/// </summary>
public int ID {
get;
set;
}
Mas como a assinatura da propriedade já informa quais operações estão disponíveis para os clientes externos da classe (nesse caso, são ambas get
e set
), sinto que os comentários são muito faladores e que talvez o seguinte seja suficiente:
/// <summary>
/// ID that uniquely identifies this <see cref="User" /> instance.
/// </summary>
public int ID {
get;
set;
}
A Microsoft usa o primeiro formulário, portanto parece uma convenção implícita. Mas acho que o segundo é melhor pelas razões que afirmei.
Entendo que essa citação é adequada para ser marcada como não sendo construtiva, mas a quantidade de propriedades que se tem que comentar é enorme e, portanto, acredito que esta questão tem o direito de estar aqui.
Aprecio todas as idéias ou links para as práticas recomendadas oficiais.
gets or sets
ou gets
dependendo deles .