Benutzer-Werkzeuge

Webseiten-Werkzeuge


pep8

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

pep8 [2018/11/09 10:41]
root angelegt
pep8 [2018/11/09 18:32] (aktuell)
root [Docstrings]
Zeile 114: Zeile 114:
   * Beginnen mit """ + gefolgt von erster Zeile Text   * Beginnen mit """ + gefolgt von erster Zeile Text
   * Die Ausführenden """ sollten unterhalb der letzten Zeile stehen (also auf einer seperaten Zeile)   * Die Ausführenden """ sollten unterhalb der letzten Zeile stehen (also auf einer seperaten Zeile)
 +
 +
 +======= Unterstriche ======
 +
 +  * Ein führender Unterstrich
 +      * "private" Objekte - es gibt keinen technischen Schutz außer das sie bei from <Pakacke> import * nicht importiert werden
 +  * Ein Unterstrich am Ende
 +      * zur Vermeidung von Namenskollisionen mit Python-Buildins
 +  * Zwei führende Unterstriche
 +      * Name-Mangling - beim Vererben wird der Klassenname aus dem die Methode/das Attribut stammt vorangestellt -> vermeidet kollisionen/ungewolltes überschreiben
 +  * Zwei führende Unterstriche und zwei nachfolgende
 +      * Magic-Method
 +
 +====== Namen ======
 +
 +===== Zu vermeidende Namen =====
 +
 +  * Kleines el (da Verwechslung mit mit groß I und 1), O (da verwechselbar mit 0) und I (groß ieh, da verwechselbar mit 1 und kleinem l)
 +      * jeweils wenn sie als Einzelvariablennamen genutzt werden sollen
 +
 +
 +===== Packages und Module =====
 +
 +  * Module
 +      * kleingeschrieben, ggf. Unterschtriche
 +  * Packages
 +      * kleingeschrieben, keine Unterstriche
 +
 +
 +===== Klassennamen =====
 +
 +  * alle Wörter im Namen beginnen mit Großbuchstaben
 +  * bsp. BrownCat
 +
 +
 +===== Exceptions ===== 
 +
 +  * entsprechend Klassen 
 +  * aber Name sollte mit Error starten wenn es sich um einen Error handelt
 +
 +
 +===== Methoden, Funktionen und Variablen =====
 +
 +  * alles kleingeschrieben
 +  * soweit nötig sollten Wörter per Underscore getrennt sein
 +
 +
 +===== Konstanten =====
 +
 +  * Alles Großgeschrieben (also komplett)
 +  * Unterstriche wenn nötig
 +
 +
 +
  
  
pep8.1541756475.txt.gz · Zuletzt geändert: 2018/11/09 10:41 von root