I am looking for a recommendation of a best practice for XML comments in C#. When you create a property, it seems like that the expected XML documentation has the following form:/// <summary>/// Gets or sets the ID the uniquely identifies this <see cref=User /> instance./// </summary>public int ID {    get;    set;}But since the signature of the property already tells you what operations are available to the external clients of the class (in this case it is both get and set) I feel like the comments are too chatty and that perhaps the following would be sufficient:/// <summary>/// ID that uniquely identifies this <see cref=User /> instance./// </summary>public int ID {    get;    set;}Microsoft uses the first form so it seems like it is an implied convention. But I think that the second one is better for the reasons I stated.I understand that this quetion is an adept for being marked as not being constructive, but the amount of properties that one has to comment is huge and so I believe that this question has its right to be here. I will appreciate any ideas or links to official recommended practices.
Is the Gets or sets .. necessary in XML documentation of properties?
c#;.net;programming practices;comments
The signature may tell other pieces of code what operations are available; however, they are not clearly shown to the coder as he or she is working and XML documentation is meant for people to consume and not a compiler.Take this class for example:public class MyClass{    /// <summary>    /// The first one    /// </summary>    public int GetOrSet { get; set; }    /// <summary>    /// The second one    /// </summary>    public int GetOnly { get; private set; }    /// <summary>    /// The last one    /// </summary>    public int SetOnly { set; private get; }}When intellisense is pulled up to access one of these properties there is no indication which ones can be written to, read from, or both:Likewise when viewing the documentation we also aren't quite sure:As such we add the gets or sets, gets, or sets to make it easier on the programmer while writing the code. It certainly would not be write a large block of code that reads and processes some data only to find out that you cannot write that data back to the property as expected.