Saya mencari rekomendasi praktik terbaik untuk komentar XML di C #. Saat Anda membuat properti, sepertinya dokumentasi XML yang diharapkan memiliki bentuk berikut:
/// <summary>
/// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance.
/// </summary>
public int ID {
get;
set;
}
Tetapi karena tanda tangan properti sudah memberi tahu Anda operasi apa yang tersedia untuk klien eksternal kelas (dalam hal ini keduanya get
dan set
) saya merasa seperti komentar yang terlalu cerewet dan bahwa mungkin yang berikut ini sudah cukup:
/// <summary>
/// ID that uniquely identifies this <see cref="User" /> instance.
/// </summary>
public int ID {
get;
set;
}
Microsoft menggunakan formulir pertama sehingga sepertinya itu adalah konvensi tersirat. Tapi saya pikir yang kedua lebih baik karena alasan yang saya nyatakan.
Saya mengerti bahwa pertanyaan ini adalah keahlian untuk ditandai sebagai tidak konstruktif, tetapi jumlah properti yang harus dikomentari sangat besar dan saya percaya bahwa pertanyaan ini memiliki hak untuk berada di sini.
Saya akan menghargai ide atau tautan apa pun ke praktik yang direkomendasikan resmi.
gets or sets
atau gets
tergantung pada pengakses properti.