Menggunakan Clang-Tidy di Visual Studio

Analisis Kode secara asli mendukung Clang-Tidy untuk proyek MSBuild dan CMake, baik menggunakan toolset Clang atau MSVC. Pemeriksaan Clang-Tidy dapat berjalan sebagai bagian dari analisis kode latar belakang. Mereka muncul sebagai peringatan dalam editor (berlekuk), dan ditampilkan di Daftar Kesalahan.

Dukungan Clang-Tidy tersedia mulai dari Visual Studio 2019 versi 16.4. Ini disertakan secara otomatis saat Anda memilih beban kerja C++ di Alat Penginstal Visual Studio.

Clang-Tidy adalah alat analisis default saat menggunakan toolset LLVM/clang-cl, yang tersedia di MSBuild dan CMake. Anda dapat mengonfigurasinya saat menggunakan toolset MSVC untuk berjalan bersama, atau untuk mengganti, pengalaman Analisis Kode standar. Jika Anda menggunakan toolset clang-cl, Microsoft Code Analysis tidak tersedia.

Clang-Tidy berjalan setelah kompilasi berhasil. Anda mungkin perlu mengatasi kesalahan kode sumber untuk mendapatkan hasil Clang-Tidy.

MSBuild

Anda dapat mengonfigurasi Clang-Tidy untuk dijalankan sebagai bagian dari Analisis Kode dan membangun di bawah halaman Analisis>Kode Umum di jendela Properti Proyek. Opsi untuk mengonfigurasi alat dapat ditemukan di bawah submenu Clang-Tidy.

Untuk informasi selengkapnya, lihat Cara: Mengatur Properti Analisis Kode untuk Proyek C/C++.

CMake

Dalam proyek CMake, Anda dapat mengonfigurasi pemeriksaan Clang-Tidy di dalam CMakeSettings.json atau CMakePresets.json.

Clang-Tidy mengenali kunci berikut:

• enableMicrosoftCodeAnalysis: Mengaktifkan Analisis Kode Microsoft
• enableClangTidyCodeAnalysis: Mengaktifkan analisis Clang-Tidy
• clangTidyChecks: Konfigurasi Clang-Tidy. Daftar pemeriksaan yang dipisahkan koma untuk diaktifkan atau dinonaktifkan. Yang terdepan - menonaktifkan pemeriksaan. Misalnya, cert-oop58-cpp, -cppcoreguidelines-no-malloc, google-runtime-int mengaktifkan cert-oop58-cpp dan google-runtime-int, tetapi menonaktifkan cppcoreguidelines-no-malloc. Untuk daftar pemeriksaan Clang-Tidy, lihat dokumentasi Clang-Tidy.

Jika tidak ada opsi "aktifkan" yang ditentukan, Visual Studio memilih alat analisis yang cocok dengan Platform Toolset yang digunakan.

Pengaturan CMake

Untuk mengedit pengaturan Clang-Tidy Anda, buka pengaturan CMake Anda, dan pilih Edit JSON di Editor Pengaturan Proyek CMake. Anda dapat menggunakan kunci di atas untuk mengisi spesifikasi Clang-Tidy Anda dalam file JSON Pengaturan CMake.

Contoh implementasi pengaturan CMake terlihat seperti ini:

{
  "configurations": [
  {
    "name": "x64-debug",
    "generator": "Ninja",
    ....
   "clangTidyChecks": "llvm-include-order, -modernize-use-override",
   "enableMicrosoftCodeAnalysis": true,
   "enableClangTidyCodeAnalysis": true
  }
  ]
}

Preset CMake

Kunci yang sama dapat digunakan dalam preset CMake Anda melalui vendor objek .

Contoh implementasi preset CMake terlihat seperti ini:

"configurePreset": [
{ "name": "base",
  ....
  "vendor": {
    "microsoft.com/VisualStudioSettings/CMake/1.0": {
      "clangTidyChecks": "llvm-include-order, -modernize-use-override",
      "enableMicrosoftCodeAnalysis": true,
      "enableClangTidyCodeAnalysis": true
      }
    }
}
]

Tampilan peringatan

Eksekusi Clang-Tidy menghasilkan peringatan yang ditampilkan dalam Daftar Kesalahan, dan sebagai bergelimpangan dalam editor di bawah bagian kode yang relevan. Untuk mengurutkan dan menata peringatan Clang-Tidy, gunakan kolom Kategori di jendela Daftar Kesalahan. Anda dapat mengonfigurasi peringatan dalam editor dengan mengaktifkan pengaturan Nonaktifkan Squiggles Analisis Kode di bawah Opsi Alat>.

Konfigurasi Clang-Tidy

Secara default, Clang-Tidy tidak mengatur pemeriksaan apa pun saat diaktifkan. Untuk melihat daftar pemeriksaan dalam versi baris perintah, jalankan clang-tidy -list-checks di prompt perintah pengembang. Anda dapat mengonfigurasi pemeriksaan yang dijalankan Clang-Tidy di dalam Visual Studio. Dalam dialog Halaman Properti proyek, buka halaman Masukkan pemeriksaan untuk dijalankan di properti Clang-Tidy Checks . Set default yang baik adalah clang-analyzer-*. Nilai properti ini disediakan untuk --checks argumen alat. Konfigurasi lebih lanjut dapat disertakan dalam file kustom .clang-tidy . Untuk informasi selengkapnya, lihat dokumentasi Clang-Tidy tentang LLVM.org.

Direktori Alat Clang-Rapi

Jika Anda ingin memiliki aturan kustom yang terpasang dalam executable clang-tidy Anda dan menjalankannya di Microsoft Visual Studio, Anda dapat mengubah jalur ke yang dapat dieksekusi yang dijalankan Visual Studio. Dalam dialog Halaman Properti proyek, buka halaman Ketik jalur atau Telusuri secara manual dan pilih jalur di bawah properti Clang-Tidy Tool Directory . Executable baru digunakan setelah perubahan disimpan, dan aplikasi dikompresi ulang.

Clang-Tidy Opsi Tambahan

Properti opsi tambahanClang-Tidy memungkinkan Anda menentukan argumen pengkompilasi tambahan yang diteruskan ke Clang-Tidy menggunakan --extra-args opsi baris perintah. Argumen ini dapat digunakan untuk mengontrol cara Clang-Tidy mengurai kode Anda, seperti menentukan makro, menyertakan jalur, atau standar bahasa. Masukkan argumen sebagai daftar yang dipisahkan titik koma. Misalnya: -std=c++20;-DMY_DEFINE=1;-Ipath\to\include.

Clang-Tidy Tambahkan Opsi Tambahan di Awal

Properti OpsiClang-Tidy Prepend Tambahan memungkinkan Anda menentukan argumen kompilator yang diteruskan ke Clang-Tidy dengan menggunakan opsi baris perintah --extra-args-before. Argumen ini disisipkan sebelum argumen kompilator default saat Clang-Tidy mengurai kode Anda. Masukkan argumen sebagai daftar yang dipisahkan titik koma. Misalnya: -std=c++20;-DMY_DEFINE=1;.

Jumlah Maksimum Proses

Properti Jumlah Maksimum Proses memungkinkan Anda menentukan berapa banyak proses yang dapat digunakan Clang-Tidy untuk menjalankan analisis secara paralel. Secara default, Clang-Tidy berjalan secara serial. Atur properti ini untuk mengaktifkan eksekusi paralel dan tentukan jumlah proses paralel. Atur ke 0 untuk menggunakan semua prosesor logis yang tersedia pada sistem Anda. Meningkatkan jumlah proses dapat meningkatkan kecepatan analisis pada mesin multi-inti.

Lihat juga

Dukungan Clang/LLVM untuk proyek MSBuild
Dukungan Clang/LLVM untuk proyek CMake