Apa yang seharusnya dan apa yang seharusnya tidak ada dalam file header? [Tutup]

Hal-hal apa yang benar-benar tidak boleh dimasukkan dalam file header?

Jika misalnya saya bekerja dengan format standar industri terdokumentasi yang memiliki banyak konstanta, apakah itu praktik yang baik untuk mendefinisikannya dalam file header (jika saya menulis parser untuk format itu)?

Fungsi apa yang harus masuk ke file header?
Fungsi apa yang seharusnya tidak?

Apa yang dimasukkan ke dalam tajuk:

• Set #includearahan minimal yang diperlukan untuk membuat header dapat dikompilasi ketika header dimasukkan dalam beberapa file sumber.
• Simbol preprosesor definisi hal-hal yang perlu dibagikan dan yang hanya dapat dicapai melalui preprosesor. Bahkan dalam C, simbol preprosesor sebaiknya dijaga agar tetap minimum.
• Maju deklarasi struktur yang diperlukan untuk membuat definisi struktur, prototipe fungsi, dan deklarasi variabel global dalam tubuh header dapat dikompilasi.
• Definisi struktur data dan enumerasi yang dibagikan di antara banyak file sumber.
• Deklarasi untuk fungsi dan variabel yang definisinya akan terlihat oleh penghubung.
• Definisi fungsi sebaris, tapi hati-hati di sini.

Apa yang tidak termasuk dalam tajuk:

• #includeArahan serampangan . Mereka serampangan termasuk menyebabkan kompilasi ulang hal-hal yang tidak perlu dikompilasi ulang, dan kadang-kadang bisa membuatnya sehingga sistem tidak dapat dikompilasi. Jangan #includefile dalam header jika header itu sendiri tidak memerlukan file header lainnya.
• Simbol preprosesor yang niatnya dapat dicapai oleh beberapa mekanisme, mekanisme apa pun, selain preprosesor.
• Banyak dan banyak definisi struktur. Bagi mereka menjadi header yang terpisah.
• Definisi fungsi sebaris yang membutuhkan tambahan #include, yang dapat berubah, atau yang terlalu besar. Fungsi-fungsi sebaris harus memiliki sedikit jika ada kipas keluar, dan jika mereka memiliki kipas keluar, itu harus dilokalisasi ke hal-hal yang didefinisikan dalam header.

Apa yang merupakan set minimal #includepernyataan?

Ini ternyata menjadi pertanyaan tidak trivial. Definisi TL; DR: File header harus menyertakan file header yang secara langsung mendefinisikan masing-masing jenis yang digunakan secara langsung atau yang secara langsung mendeklarasikan setiap fungsi yang digunakan dalam file header yang dimaksud, tetapi tidak boleh menyertakan hal lain. Pointer atau tipe referensi C ++ tidak memenuhi syarat sebagai penggunaan langsung; referensi ke depan lebih disukai.

Ada tempat untuk #includearahan gratis , dan ini dalam tes otomatis. Untuk setiap file header dalam paket perangkat lunak, saya secara otomatis menghasilkan dan kemudian mengkompilasi yang berikut:

#include "path/to/random/header_under_test"
int main () { return 0; }

Kompilasi harus bersih (mis. Bebas dari segala peringatan atau kesalahan). Peringatan atau kesalahan mengenai tipe tidak lengkap atau tipe tidak dikenal berarti bahwa file header yang diuji memiliki beberapa #includearahan yang hilang dan / atau hilang deklarasi maju. Catatan baik: Hanya karena tes lulus tidak berarti bahwa set #includearahan cukup, apalagi minimal.

Selain apa yang sudah dikatakan.

File H harus selalu mengandung:

• Dokumentasi kode sumber !!! Minimal, apa tujuan dari berbagai parameter dan mengembalikan nilai fungsi.
• Pelindung kepala, #ifndef MYHEADER_H #define MYHEADER_H ... #endif

File H tidak boleh mengandung:

• Segala bentuk alokasi data.
• Definisi fungsi. Fungsi sebaris mungkin pengecualian langka dalam beberapa kasus.
• Apa pun yang berlabel static.
• Typedefs, #define, atau konstanta yang tidak memiliki relevansi dengan aplikasi lainnya.

(Saya juga akan mengatakan bahwa tidak pernah ada alasan untuk menggunakan variabel global / eksternal non-konstan, di mana saja, tapi itu diskusi untuk pos lain.)

Saya mungkin tidak akan mengatakan tidak pernah, tetapi pernyataan yang menghasilkan data dan kode seperti diuraikan seharusnya tidak dalam file .h.

Makro, fungsi inline, dan templat mungkin terlihat seperti data atau kode, tetapi makro tidak menghasilkan kode saat diuraikan, tetapi saat digunakan. Barang-barang ini sering perlu digunakan di lebih dari satu .c atau .cpp, sehingga barang-barang tersebut termasuk dalam .h.

Dalam pandangan saya, file header harus memiliki antarmuka praktis minimum untuk .c atau .cpp yang sesuai. Antarmuka dapat mencakup # definisi, kelas, typedef, definisi struktur, prototipe fungsi, dan definisi eksternal yang kurang disukai, untuk variabel global. Namun, jika deklarasi hanya digunakan dalam satu file sumber, itu mungkin harus dikecualikan dari .h dan terkandung dalam file sumber sebagai gantinya.

Beberapa mungkin tidak setuju, tetapi kriteria pribadi saya untuk file .h adalah bahwa mereka # mencantumkan semua file .h lain yang mereka butuhkan untuk dapat dikompilasi. Dalam beberapa kasus, ini bisa menjadi banyak file, jadi kami memiliki beberapa metode yang efektif untuk mengurangi dependensi eksternal seperti meneruskan deklarasi ke kelas yang memungkinkan kami menggunakan pointer ke objek kelas tanpa menyertakan apa yang bisa menjadi pohon besar file include.

File header harus memiliki organisasi berikut:

• jenis dan definisi konstan
• deklarasi objek eksternal
• deklarasi fungsi eksternal

File header tidak boleh berisi definisi objek, hanya ketik definisi dan deklarasi objek.

Pernyataan yang menghasilkan data dan kode saat diuraikan, tidak boleh dalam .hfile. Sejauh menyangkut sudut pandang saya, file header seharusnya hanya memiliki antarmuka praktis minimum untuk yang sesuai .catau .cpp.