Saya menyadari bahwa format "header comment" bervariasi dari programmer ke programmer, tetapi apa yang akan menjadi contoh dari komentar header "bagus"?
c++
coding-style
comments
code-formatting
headers
Mateen Ulhaq
sumber
sumber
Jawaban:
Mengenai gaya pemformatan, konsistensi adalah yang paling penting untuk diperjuangkan. Pastikan setiap komentar definisi kelas terlihat seperti yang lainnya, setiap komentar metode terlihat seperti yang lainnya, dll.
Jadi, jika Anda memodifikasi kode yang ada , pastikan Anda mengikuti gaya pemformatan mereka. Komentar (dan, sampai batas tertentu, kode) akan terlihat seperti hanya satu orang yang mengerjakan file. Jika Anda memulai proyek baru, pilih satu format gaya dan tetap menggunakannya.
Tempat untuk mulai mencari:
sumber