Mengonfigurasi C/C++ Sertakan Pembersihan di Visual Studio

Mulai dari 17.8 Pratinjau 1, Visual Studio dapat membersihkan file yang Anda #include untuk meningkatkan kualitas kode C dan C++ Anda dengan cara-cara berikut:

• Menawarkan penambahan file header untuk kode yang hanya dapat dikompilasi karena file header yang diperlukan diikutkan secara tidak langsung oleh file header lain.
• Menawarkan penghapusan file header yang tidak digunakan--mempercepat waktu build.

Artikel ini menjelaskan cara mengonfigurasi Include Cleanup di Visual Studio. Untuk informasi selengkapnya tentang Include Cleanup, lihat Gambaran umum Include Cleanup C/C++.

Aktifkan opsi Sertakan Pembersihan

Fitur Include Cleanup dinonaktifkan secara default.

Aktifkan dengan memilihOpsi>Alat>Editor> TeksC/C++>Code Cleanup dan pilih Aktifkan pembersihan #include.

Kemudian gunakan menu dropdown untuk mengonfigurasi tingkat keparahan pemberitahuan tentang peluang untuk menambahkan header tidak langsung atau menghapus header yang tidak digunakan:

Kotak centang **Aktifkan pembersihan #include** dipilih. Menu tarik-turun untuk **Tingkat saran Hapus include yang tidak digunakan** dan **Tingkat saran Tambahkan include yang hilang** ditampilkan. Isi dropdown ditampilkan, yaitu: **Pemfaktoran ulang saja**, **Saran**, **Peringatan**, dan **Kesalahan**. Daftar tarik-turun **Tingkat saran untuk menghapus include yang tidak digunakan** menawarkan opsi yang sama, tetapi juga menambahkan **Diredupkan**.

Opsi ini mengatur jenis notifikasi tentang header yang tidak digunakan yang diberikan oleh fitur Include Cleanup:

Diredupkan

Include Cleanup menampilkan file header yang tidak digunakan dengan meredupkan baris file header yang tidak digunakan pada editor kode, serta menampilkan pesan di jendela Daftar Kesalahan. Di editor kode, arahkan kursor Anda ke ikon #include yang tampak redup untuk memunculkan menu tindakan cepat dan pilih Tampilkan kemungkinan perbaikan, atau klik menu tarik-turun ikon lampu, untuk melihat tindakan yang berkaitan dengan file yang tidak digunakan.

Baris untuk #include < iostream > diredupkan karena baris kode yang menggunakan iostream dikomentari. Baris kode tersebut adalah // std::cout << "charSize = " << charSize; Menu tindakan cepat juga terlihat untuk baris ini. Tertulis bahwa #include < iostream > tidak digunakan di file ini, dan menyertakan tautan ke “Tampilkan kemungkinan perbaikan”.

Hanya pemfaktoran ulang: Include Cleanup menawarkan tindakan yang dapat Anda lakukan melalui menu tindakan cepat di editor kode saat Anda mengarahkan penunjuk mouse ke #include, atau meletakkan kursor pada baris #include lalu menekan Ctrl+.

Saat mengarahkan kursor ke atas `#include `, ikon lampu muncul dengan teks bahwa `#include ` tidak digunakan di file ini.

Saran, Peringatan, Kesalahan: Sertakan Pembersihan dapat menampilkan Sertakan pesan Pembersihan sebagai saran, peringatan, atau kesalahan di jendela Daftar Kesalahan . Anda menentukan yang mana. Dalam cuplikan layar Daftar Kesalahan berikut, Include Cleanup dikonfigurasi untuk menampilkan berkas header yang tidak digunakan sebagai peringatan. Pastikan Build + Intellisense dipilih pada filter tarik-turun agar Anda dapat melihat output Include Cleanup:

Filter dropdown diatur ke **Build + IntelliSense**. Peringatan terlihat: VCIC002 - '#include ' tidak digunakan dalam file ini."

Opsi konfigurasi lainnya

Pengaturan Pembersihan Penyertaan lainnya tersedia di bawah Alat>Opsi>Editor Teks>C/C++>Pembersihan Kode:

• Urutkan include: Menandai arahan #include yang perlu diurutkan. Pilih tingkat pemberitahuan tingkat keparahan pesan yang muncul di jendela Daftar Kesalahan : Tidak ada (fitur nonaktif), Saran, Peringatan, atau Kesalahan.
• Gaya: Mengontrol cara #include pernyataan diurutkan. Pilih Abaikan untuk mengurutkan tanpa mempertimbangkan gaya kurung, Tanda kutip untuk mengurutkan direktif include bertanda kutip di atas direktif include dengan kurung sudut, atau Kurung sudut untuk mengurutkan direktif include dengan kurung sudut di atas direktif include bertanda kutip.
• Peka huruf besar/kecil: Saat dipilih, pengurutan membandingkan nama file dengan membedakan huruf besar/kecil. Jika dikosongkan, pengurutan tidak membedakan huruf besar/kecil.

Mengonfigurasi Sertakan Pembersihan dengan .editorconfig

Fitur Pembersihan Include memiliki lebih banyak opsi, seperti mengecualikan include tertentu dari saran pembersihan dan menandai bahwa beberapa file header diperlukan agar alat tidak menandainya sebagai tidak digunakan. Tentukan opsi ini dalam .editorconfig file. Tambahkan file ini ke proyek Anda untuk menerapkan gaya pengodean yang konsisten untuk semua orang yang bekerja di basis kode. Untuk informasi selengkapnya tentang menambahkan .editorconfig file ke proyek Anda, lihat Membuat pengaturan editor kustom portabel dengan EditorConfig.

Pengaturan .editorconfig yang dapat digunakan dengan Include Cleanup adalah:

Pengaturan	Nilai	Contoh
cpp_include_cleanup_add_missing_error_tag_type Mengatur tingkat kesalahan untuk menambahkan pesan sertakan transitif.	none suggestion warning error	cpp_include_cleanup_add_missing_error_tag_type = suggestion
cpp_include_cleanup_alternate_files Sembunyikan pesan untuk penyertaan tidak langsung. Misalnya, jika Anda #include <windows.h> dan hanya menggunakan konten dari header winerror.h yang disertakan secara tidak langsung atau minwindef.h, alat tidak menyarankan untuk menambahkannya.	file1:file2[:file3...][,file4:file5...]	cpp_include_cleanup_alternate_files = windows.h:winerror.h:minwindef.h Atau cpp_include_cleanup_alternate_files = windows.h:winerror.h:minwindef.h,umbrella.h:internal.h
cpp_include_cleanup_excluded_files Mengecualikan file-file yang ditentukan dari pesan Include Cleanup. Anda tidak akan mendapatkan saran yang terkait dengan header sama sekali, baik tentang menambahkannya atau tentang ketidakgunannya.	filename	cpp_include_cleanup_excluded_files = vcruntime.h, vcruntime_string.h
cpp_include_cleanup_remove_unused_error_tag_type Mengatur tingkat kesalahan untuk menghapus pesan sertakan yang tidak digunakan.	none suggestion warning error dimmed	cpp_include_cleanup_remove_unused_error_tag_type = dimmed
cpp_include_cleanup_replacement_files Mengganti file1 dengan file2 selama pemrosesan Include Cleanup. Misalnya, Anda mungkin lebih suka menggunakan cstdio lebih dari stdio.h. Jika Anda memiliki file yang berisi #include <cstdio> dan #include <stdio.h>, dan Anda hanya menggunakan konten dari stdio.h, dengan pengaturan ini Include Cleanup akan memberi tahu Anda untuk menghapus stdio.h karena selama pemrosesan, penggunaan cstdio telah digantikan dengan stdio.h. Jika Anda tidak menggunakan isi dari salah satunya, Include Cleanup akan memberi tahu Anda untuk menghapus keduanya.	file1:file2	cpp_include_cleanup_replacement_files = stdio.h:cstdio,stdint.h:cstdint
cpp_include_cleanup_required_files Tentukan bahwa penggunaan file1 memerlukan file2. Misalnya, tentukan bahwa jika Anda menggunakan atlwin.h, maka altbase.h juga harus disertakan.	file1:file2	cpp_include_cleanup_required_files = atlwin.h:altbase.h, atlcom.h:altbase.h
cpp_sort_includes_error_tag_type Mengatur tingkat kesalahan untuk pesan sort-includes. none menonaktifkan fitur. suggestion menampilkan garis bergelombang ... dan menambahkan pesan ke daftar kesalahan. warning menampilkan garis bergelombang hijau dan menambahkan peringatan. error menampilkan garis bergelombang merah dan menandai kesalahan.	none suggestion warning error	cpp_sort_includes_error_tag_type = suggestion
cpp_sort_includes_priority_case_sensitive Saat true, perbandingan pengurutan menyertakan nama file secara peka huruf besar/kecil. Ketika false, pengurutan tidak membedakan huruf besar/kecil.	true false	cpp_sort_includes_priority_case_sensitive = false
cpp_sort_includes_priority_style Menentukan apakah pengurutan mempertimbangkan gaya kurung. ignore mengurutkan tanpa mempertimbangkan tanda kurung. quoted mengurutkan include bertanda kutip di atas include dengan tanda kurung sudut. angle_brackets mengurutkan include bertanda kurung sudut di atas include bertanda kutip.	ignore quoted angle_brackets	cpp_sort_includes_priority_style = quoted

Lihat juga

Gambaran umum C/C++ Sertakan Pembersihan
Sertakan pesan Pembersihan