Als Entwickler ist es wichtig, Ihren Code so zu formatieren, dass er leicht zu lesen und zu verstehen ist. Das lässt Sie nicht nur wie ein Experte aussehen (was Ihnen bei der Jobsuche helfen kann), sondern trägt auch dazu bei, dass Ihr Code fehlerfrei ist. In diesem Blogbeitrag erfahren Sie, warum die Formatierung so wichtig ist, und wir geben Ihnen einige Tipps, wie Sie sie effektiv durchführen können.
Eines der wichtigsten Dinge, die Sie tun können, um Ihren Code leicht lesbar zu machen, ist die Verwendung einer guten Formatierung. Dazu gehören die richtige Einrückung, die richtigen Abstände und Zeilenumbrüche. Beim Kodieren ist es außerdem wichtig, dass Sie bei der Formatierung einheitlich vorgehen – verwenden Sie zum Beispiel immer die gleiche Anzahl von Leerzeichen für die Einrückung und mischen Sie keine Tabulatoren
Viele Code-Editoren verfügen über integrierte Formatierungsoptionen, mit denen Sie Ihren Code automatisch nach Ihren Wünschen formatieren können. Der beliebte Atom-Texteditor verfügt beispielsweise über eine Option “Code formatieren” im Menü “Pakete”. Schauen Sie in die Dokumentation Ihres Code-Editors, um zu sehen, welche Optionen Ihnen zur Verfügung stehen.
Sie denken jetzt vielleicht”Warum sich mit der Formatierung beschäftigen? Ist das nicht nur eine Frage der persönlichen Vorliebe?” Die Antwort ist nein – eine korrekte Formatierung des Codes kann tatsächlich helfen, Fehler zu vermeiden.
Betrachten Sie die folgenden zwei Codeschnipsel:
Der Zweite Beispiel ist richtig formatiert und leicht zu lesen. Der erste Beispiel ist schlecht formatiert und schwer zu lesen. Wenn Sie eine Änderung am ersten Schnipsel vornehmen würde, wäre es leicht, versehentlich einen Fehler einzuführen.
Ordnungsgemäß formatierter Code ist auch leichter zu debuggen. Wenn Sie versuchen, einen Fehler zu finden, kann es eine große Hilfe sein, wenn Sie Ihren Code schnell durchsehen und verstehen können, was er tut. Im Gegensatz dazu kann schlecht formatierter Codeschwieriger zu debuggen, weil es schwieriger ist zu verstehen, was vor sich geht.
Eine einfache Github Action kann Ihnen hier helfen dies automatisch zu machen.
Und alles was automatisch Funktioniert sollten Sie als Entwickler lieben.
Erstellen Sie in Github ein Projekt. Für die die Github Action müssen Sie hier ein Verzeichnis anlegen mit dem Namen .github und in diesem Verzeichnis ein Verzeichnis mit dem Namen workflow.
Hier fügen Sie den Datei black.yaml ein. Mit der Syntax on: [push, pull_request] sagen wir das dieser Workflow immer laufen soll mit jeder push oder pull request.
Der Workflows soll immer “runs on ubuntu latest” laufen. Sie können anstatt runs on ubuntu lastest natürlich auf Windows oder Mac benutzen.
Im ersten Beispiel zeigen wir nur Code an der formatiert werden sollte.
name: Lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: psf/black@stable
with:
options: ". --exclude /alembic/"
Diese Github Actions pushed aber den die Code Formatting nicht wieder zurück.
In unserem How to wollen wir Ihnen aber zeigen wie Sie direkt den Code automatisch Formatieren können.
name: Lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.9'
architecture: x64
- name: Install Python dependencies
run: |
pip install black
- uses: wearerequired/lint-action@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
black: true
black_args: "--exclude /migrations/"
auto_fix: true
commit_message: "Fix code style issues with ${linter}"
Wichtig ist dafür das Sie den token secrets.github_token github.com github.repository als Secrets mit angeben.
Sie können gerne unser Github Repo kopieren: https://github.com/dajor/code_styple_example
Hier werden Änderungen von Code Style automatisch wieder in Ihr Git Projekt übergeben.
Wenn Sie Hilfe in Ihrem DevOp Prozess benötigen schreiben Sie uns. Gerne unterstützen wir Sie hier in einem Projekt.
