Format komentar tajuk

10

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
Apakah pertanyaan ini hanya tentang pemformatan, atau tentang gaya dan konten?
— Macneil
@ Macneil Tergantung pada apa artinya. Untuk saat ini, saya akan bermain aman dan mengatakan "keduanya". :)
— Mateen Ulhaq

Jawaban:

5

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:

— JK
sumber
Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.