Python Code Style Guide

Stilanleitung für Python-Code

Stilrichtlinien sollen die Lesbarkeit von Code verbessern und ihn über das breite Spektrum des Python-Codes hinweg konsistent machen. Der PEP 8 – Stilleitfaden für Python-Code:

PEP 8 – Stilanleitung für Python-Code

ist derzeit der am weitesten verbreitete Styleguide.

FASTSUITE Code verwendet hauptsächlich den CapitalizedWords (oder CapWords, oder CamelCase) Namensstil, daher wird empfohlen, diesen Stil in allen Kundenprojekten zu befolgen.

Allgemeine CENIT-Stilempfehlungen

Klassen- und Funktionsnamen

• Klassen- und Funktionsnamen sollten normalerweise die CapWords-Konvention verwenden, zum Beispiel MyFirstClass oder MyFirstFunction.

Variablennamen

• Lokale Variablen: localVariable
• Globale Variablen innerhalb eines Moduls: GlobalVariable
• Konstanten: CONSTANT_VARIABLE
• Private Variablen: _semiPrivate und __superPrivate

Kommentare und Beschreibungen

Bitte nutzen Sie

autoDocstring

Erweiterung (siehe

Empfohlene VS Code-Erweiterungen

).

• Klassen und Funktionen sollten mit dreifachen Anführungszeichen dokumentiert werden, zum Beispiel """Description"""
• Hashtags sollten nur für Inline-Code-Kommentare verwendet werden: # Comment

Codebeispiel

• Bitte sehen Sie sich eine der cenpylib Klassen als Beispiel an.