Die Verwendung der richtigen Codeformatierung ist ein wichtiger Bestandteil der Softwareentwicklung. Es bietet einen besser lesbaren und strukturierten Code, der das Verständnis und die Wartung des Codes erheblich erleichtert. Derzeit gibt es viele Tools, mit denen Sie den Code automatisch entsprechend dem von Ihnen gewählten Designstil formatieren können.
Ein solches Werkzeug ist clang format. Es ist Teil des LLVM-Projekts und bietet umfangreiche Möglichkeiten zum Anpassen der Codeformatierung in C, C++, Objective-C und anderen Sprachen. Es kann jedoch für einige Entwickler schwierig sein, das Clang-Format einzurichten. In diesem Artikel betrachten wir eine ausführliche Anleitung zum Konfigurieren des Clang-Formats in der CLion-Entwicklungsumgebung.
CLion ist eine beliebte integrierte Entwicklungsumgebung (IDE) von JetBrains, die eine breite Palette von Tools für die Entwicklung in C++ und anderen Sprachen bietet. CLion enthält Unterstützung für das "Out of the box" -Clang-Format, das es einfach macht, es in Projekten einzurichten und zu verwenden. In diesem Handbuch werden wir die Schritte zum Aktivieren und Konfigurieren des Clang-Formats in CLion untersuchen, um eine einheitliche Formatierung Ihres Codes zu gewährleisten.
Wie setze ich das clang format in CLion
CLion bietet eine Integration in das Clang Format-Codeformatierungstool, mit dem Sie den Code automatisch an einen bestimmten Stil anpassen können. Befolgen Sie die folgenden Schritte, um das clang format auf CLion zu setzen:
Stellen Sie sicher, dass Sie das clang format auf Ihrem System installiert haben. Wenn Sie das clang format nicht haben, können Sie es mit dem Paketmanager Ihres Betriebssystems installieren (z. B. mit apt-get in Ubuntu oder brew in macOS).
Öffnen Sie die CLion-Einstellungen, indem Sie im Menü Datei "Einstellungen" (oder "Einstellungen" unter Windows/Linux) auswählen.
Gehen Sie zu "Editor" > "Code Style" und wählen Sie die Registerkarte "C/C++".
In diesem Abschnitt finden Sie das Feld "Formatter". Wählen Sie darin die Option "clangformat" aus, mit der CLion das clang format zum Formatieren des Codes verwendet.
Klicken Sie auf "Set From". " neben dem Feld "Formatter". Wählen Sie in der angezeigten Liste den Pfad zur ausführbaren Clang Format-Datei auf Ihrem System aus.
Nachdem Sie den Pfad zum clang format ausgewählt haben, klicken Sie auf "Übernehmen" oder "OK", um die Einstellungen zu speichern.
Nachdem Sie diese Schritte ausgeführt haben, verwendet CLion das clang format, um den Code entsprechend dem ausgewählten Stil und den ausgewählten Einstellungen zu formatieren.
Was ist clang format und wofür ist es notwendig
Mit Clang format können Sie verschiedene Aspekte der Codeformatierung anpassen, z. B. Einrücken, Verwenden von Leerzeichen, Platzieren von geschweiften Klammern und anderen Strukturelementen. Es unterstützt verschiedene Formatierungsstile wie LLVM, Google, Chromium und viele andere oder ermöglicht es Ihnen, Ihren eigenen Stil entsprechend den Projektanforderungen zu erstellen.
Die Verwendung des Clang-Formats bei der Entwicklung ermöglicht es, den Codierungsstil zu standardisieren und die Wartung des Quellcodes zu vereinfachen. Es wurde für die Verwendung in einer Entwicklungsumgebung entwickelt, um sicherzustellen, dass Code beim Speichern einer Datei oder bei Bedarf automatisch formatiert wird.
Darüber hinaus kann das clang format während der kontinuierlichen Integration verwendet werden, um den Codierungsstil zu überprüfen, bevor Änderungen an der zugrunde liegenden Codebasis vorgenommen werden. Dies hilft, den Codierungsstil im Projekt einheitlich zu halten und erleichtert die Codewartung durch das Entwicklungsteam.
| Vorteile der Verwendung von clang format: |
|---|
| ✓ Erleichtert das Lesen und Verstehen von Code |
| ✓ Standardisiert den Codierungsstil im Projekt |
| ✓ Erleichtert die Wartung des Quellcodes |
| ✓ Verbessert die Qualität und Lesbarkeit des Codes |
Installieren von clang format auf einem Computer
Clang format ist ein Tool zum automatischen Formatieren von C++ - Code mit einem vordefinierten Stil. Bevor Sie das clang format in CLion verwenden können, müssen Sie es auf Ihrem Computer installieren. Im Folgenden sind die Schritte zum Installieren des Clang-Formats aufgeführt:
- Öffnen Sie ein Terminal oder eine Eingabeaufforderung.
- Installieren Sie das clang format, indem Sie den folgenden Befehl ausführen:
sudo apt install clang-format
Bei der Installation von clang format müssen Sie möglicherweise ein Administratorkennwort eingeben. Nachdem Sie das Kennwort eingegeben haben, wird die Installation gestartet.
Nachdem Sie das clang format erfolgreich installiert haben, können Sie seine Version überprüfen, indem Sie den Befehl clang-format --version eingeben.
Jetzt können Sie clang format verwenden, um den Code in CLion zu formatieren. Im folgenden Abschnitt des Handbuchs wird ausführlich beschrieben, wie Sie das clang format in CLion konfigurieren.
Vorbereitung für die Installation
Bevor Sie das clang format in CLion installieren, müssen Sie einige vorläufige Schritte ausführen:
1. Stellen Sie sicher, dass CLion auf Ihrem Computer installiert ist. Wenn Sie es nicht haben, laden Sie es herunter und installieren Sie es von der offiziellen Website.
2. Stellen Sie sicher, dass Sie den Clang-Compiler installiert haben. Um dies zu überprüfen, öffnen Sie ein Terminal (oder eine Eingabeaufforderung in Windows) und geben Sie den Befehl ein:
Wenn Sie eine Version des Compilers sehen, ist diese Version bereits auf Ihrem Computer installiert. Wenn nicht, müssen Sie es installieren, bevor Sie fortfahren.
3. Stellen Sie sicher, dass Sie cmake installiert haben. Überprüfen Sie auch, ob es vorhanden ist, indem Sie einen Befehl eingeben:
Wenn die Version angezeigt wird, ist cmake bereits installiert. Wenn nicht, installieren Sie es, bevor Sie mit dem nächsten Schritt fortfahren.
Herunterladen und Installieren von clang format
Zuerst müssen Sie das clang format herunterladen und installieren:
Schritt 1:
Laden Sie das Clang format-Archiv für Ihr Betriebssystem von der offiziellen LLVM-Website herunter: https://github .com/llvm/llvm-project/releases.
Beachten Sie, dass das clang format Teil des LLVM-Pakets ist, daher müssen Sie es zusammen mit LLVM herunterladen.
Schritt 2:
Entpacken Sie das heruntergeladene Archiv nach dem Download.
Unter Linux und macOS können Sie den Inhalt eines Archivs in ein beliebiges Verzeichnis extrahieren. Zum Beispiel können Sie den Befehl verwenden:
tar xf clang+llvm-13.0.0-x86_64-linux-gnu-ubuntu-20.04.tar.xz
Für Windows müssen Sie das Verzeichnis erstellen, in das Sie das clang format installieren möchten, und den Inhalt des Archivs darin extrahieren.
Schritt 3:
Nachdem Sie den Inhalt des Archivs extrahiert haben, müssen Sie der Umgebungsvariablen PATH den Pfad zum clang format hinzufügen.
Unter Linux und macOS können Sie einen Pfad hinzufügen, indem Sie den folgenden Befehl im Terminal ausführen:
Für Windows können Sie den Pfad über die Systemeinstellungen hinzufügen, indem Sie zu Systemsteuerung > System und Sicherheit > System > Erweiterte Systemeinstellungen > Umgebungsvariablen navigieren.
Jetzt haben Sie das clang format installiert und es ist über die Befehlszeile verfügbar.
Clang format in CLion einrichten
CLion ermöglicht die Integration in das Clang Format-Tool, mit dem Sie den Code automatisch entsprechend einem bestimmten Codierungsstil formatieren können. Im Folgenden sind die Schritte aufgeführt, die Sie befolgen müssen, um das clang format in CLion zu konfigurieren.
Schritt 1: Installieren des Clang-Formats
Bevor Sie mit der Verwendung von clang format in CLion beginnen, müssen Sie sicherstellen, dass Sie das Clang format-Tool installiert haben. Sie können überprüfen, ob es vorhanden ist, indem Sie den Befehl clang-format --version in der Befehlszeile ausführen. Wenn das Werkzeug nicht installiert ist, müssen Sie es installieren, bevor Sie fortfahren.
Schritt 2: Erstellen Sie die Datei .clang-format
Um das clang format einzurichten, müssen Sie eine Datei mit dem Namen erstellen.clang-format im Stammordner Ihres Projekts oder in dem Ordner, in dem sich die Quellcodedatei befindet, die Sie formatieren möchten. In dieser Datei können Sie verschiedene Formatierungseinstellungen nach Ihren Wünschen definieren. Beispiele für diese Einstellungen finden Sie in der clang format-Dokumentation.
Schritt 3: Verbinden Sie die Datei .clang-format in CLion
Damit CLion Ihre Datei verwendet .clang-format um den Code zu formatieren, müssen Sie ihn zu den Projekteinstellungen hinzufügen. Öffnen Sie dazu das CLion-Einstellungsfenster, wählen Sie die Registerkarte "Editor" und klicken Sie auf die Registerkarte "Code Style". Wählen Sie dann "C/C++" in der Liste der ausgewählten Sprachen aus und klicken Sie auf den Link "Set from. " neben dem Wert "Scheme". Wählen Sie im angezeigten Dialogfeld Projekt aus und klicken Sie auf OK. Geben Sie danach den Pfad zu Ihrer Datei an .clang-format im Feld "ClangFormat ausführbar" und klicken Sie auf "OK", um die Einstellungen zu speichern.
Schritt 4: Verwenden des Clang-Formats in CLion
Jetzt, da CLion so konfiguriert ist, dass es das clang format verwendet, können Sie es verwenden, um den Code zu formatieren. Öffnen Sie dazu die Datei, die Sie formatieren möchten, und wählen Sie den Menüpunkt "Code" -> "Code Reformat" oder verwenden Sie eine Tastenkombination Ctrl + Alt + L (für Windows / Linux) oder Cmd + Option + L (für macOS). CLion wendet die Formatierungseinstellungen automatisch aus Ihrer Datei an .clang-format und formatiert Ihren Code entsprechend.
Jetzt wissen Sie, wie Sie das clang format in CLion konfigurieren und verwenden, um den Code entsprechend Ihren Codierungsstilpräferenzen zu formatieren. Verwenden Sie dieses Tool, um die Effizienz und Lesbarkeit Ihres Codes zu verbessern!
CLion-Einstellungen öffnen
Um das clang format in CLion zu konfigurieren, müssen Sie die IDE-Einstellungen öffnen. Befolgen Sie die folgenden Schritte, um die gewünschten Einstellungen zu finden:
- Öffnen Sie CLion und gehen Sie zum Menü Datei.
- Wählen Sie im Dropdown-Menü den Punkt "Einstellungen" aus.
- Suchen Sie im geöffneten Einstellungsfenster den Abschnitt "Editor" und klicken Sie darauf.
- Im Abschnitt "Editor" sehen Sie den Unterabschnitt "Code Style". Klicken Sie darauf.
- Wählen Sie im Abschnitt "Code Style" die Registerkarte "C/C++" aus.
Sie befinden sich jetzt in den Formatierungseinstellungen für C/C++. Als nächstes müssen Sie das Clang-Format verwenden, indem Sie auf die Schaltfläche "Set from" klicken. " und wählen Sie eine Datei mit den Clang Format-Einstellungen aus.
Nachdem Sie eine clang format Einstellungsdatei ausgewählt haben, werden die Formatierungseinstellungen entsprechend der ausgewählten Datei angewendet. Jetzt können Sie die Codeformatierung in CLion nach Ihren Wünschen anpassen. Speichern Sie die Einstellungen und schließen Sie das Einstellungsfenster, um die Änderungen zu übernehmen.
Einrichten des Compilers für clang format
Hier ist ein Anwendungsbeispiel:
cmake_minimum_required(VERSION 3.10)project(MyProject)# Путь к исполняемому файлу clang-formatset(CLANG_FORMAT_EXECUTABLE /usr/bin/clang-format)# Опции компиляции для clang formatset(CLANG_FORMAT_OPTIONS -style=file -fallback-style=none)# Полный путь к файлу .clang-formatset(CLANG_FORMAT_CONFIG_FILE $/.clang-format)# Добавляем опцию компиляции, чтобы вызвать clang-format во время компиляцииset(CMAKE_CXX_FLAGS "$ -Xclang -plugin-arg-clang-format -Xclang -add-plugin -Xclang clang-format")# Включаем поддержку clang format для всех файлов с расширениями .cpp и .hset(CMAKE_CXX_EXTENSIONS OFF)set(CMAKE_CXX_STANDARD 11)# Добавляем исходные файлы вашего проектаadd_executable(MyProject main.cpp)# Связываем исполняемый файл с библиотекой clang formattarget_link_libraries(MyProject $)In diesem Beispiel geben wir den Pfad zur ausführbaren Datei clang-format, die Kompilierungsoptionen für clang format und den vollständigen Dateipfad an .clang-format und fügen Sie eine Kompilierungsoption hinzu, um den Aufruf von clang-format zur Kompilierzeit zu aktivieren.
Wenn Ihr Projekt einen anderen Compiler verwendet, müssen Sie möglicherweise auch die CMakeLists-Datei bearbeiten.txt, um den korrekten Pfad zur ausführbaren clang-Format-Datei und die Kompilierungsoptionen anzugeben.
Nachdem der Compiler das clang format konfiguriert hat, wendet er automatisch den in der Datei angegebenen Codierungsstil an .clang-format, für alle Ihre Quelldateien während des Kompilierungsprozesses.
Dadurch wird sichergestellt, dass der Codierungsstil in Ihrem Projekt einheitlich ist und Sie die Zeit sparen, die Sie für die manuelle Formatierung des Codes aufgewendet haben.
Formatierungsstile in clang format anpassen
Sie müssen eine Datei erstellen, um die Formatierungsstile anzupassen .clang-format, in dem die Formatierungsregeln für Ihren Code angegeben werden. Datei.das clang-Format sollte sich im Stammverzeichnis Ihres Projekts befinden.
Datei.clang-format ist eine Textdatei und muss der YAML-Syntax folgen. Sie müssen verschiedene Formatierungsstile angeben, z. B. Einrücken, Leerzeichen, Zeilenumbrüche usw.
Hier ist ein Beispiel für den Inhalt einer Datei .clang-format, damit Sie leichter verstehen können, wie Sie Stile angeben:
BasedOnStyle: LLVMAccessModifierOffset: -2AlignConsecutiveAssignments: trueAlignConsecutiveDeclarations: trueAlignConsecutiveMacros: trueAllowAllArgumentsOnNextLine: true
In der Datei .clang-format Sie können die Werte ändern und Formatierungsregeln hinzufügen oder entfernen, je nach Ihren Vorlieben.
Nachdem Sie die Datei erstellt haben .clang-format, öffnen Sie die CLion-Einstellungen, gehen Sie zum Editor und wählen Sie Code Style. Alle Ihre Formatierungseinstellungen werden automatisch verbunden.
Sie können auch separate Formatierungsregeln konfigurieren, indem Sie in den Einstellungen zum Abschnitt "C/C++" gehen und "ClangFormat" auswählen. Hier können Sie vorhandene Stile bearbeiten oder eigene hinzufügen, um die Formatierung im clang Format fein abzustimmen.
Nachdem Sie Formatierungsstile im clang format konfiguriert haben, wendet CLion diese Stile automatisch an, wenn Sie den Code in Ihrem Projekt formatieren. Dadurch können Sie standardisierten und lesbaren Code beibehalten und den Zeitaufwand für die manuelle Formatierung reduzieren.
