Python mehrzeiligen Kommentar indent

Question

Ich habe ein Projekt Django, und an einigen Stellen haben wir mehrzeilige Kommentare gegliederte wie folgt:

field = models.IntegerField(default=0, null=True) # 0-initial_email_sent 
                # 1-second_email_sent 
                # 2-third_email_sent 

Dies zeigt deutlich PEP verletzt, aber meiner Meinung nach, hilft bei der Lesbarkeit. Natürlich könnte ich Kommentare wie folgt setzen:

# 0-initial_email_sent 
# 1-second_email_sent 
# 2-third_email_sent 
field = models.IntegerField(default=0, null=True) 

, aber ich würde lieber die erste bevorzugen.

Gibt es eine Möglichkeit, Kommentare als solche einzurücken, ohne PEP zu verletzen?

Answer 1

Magische Zahlen sind schlecht, so dass die beste Dokumentation ist hier genannt zu verwenden (pseudo) Konstanten:

INITIAL_EMAIL_SENT = 0 
SECOND_EMAIL_SENT = 1 
THIRD_EMAIL_SENT = 2 
field = models.IntegerField(default=INITIAL_EMAIL_SENT, null=True) 

Als allgemeine Regel gilt, je weniger, desto besser (freies Code Bedürfnisse zu äußern keine oder sehr wenige Kommentare).

Für eine allgemeinere Antwort darüber, wo Kommentare zu platzieren, speziell mehrzeilige diejenigen:

1. die Kommentare, die vor der kommentierten Artikel, was die Nutzer am meisten Python ist also zu erwarten für die meisten ist es ist " besser lesbar "

2. es macht auch Code-Bearbeitung einfacher (Sie haben keine Kommentare mit Code gemischt, müssen Sie Kommentare Einrückung usw. nicht beibehalten).

Wenn es Ihr eigenes persönliches Projekt ist und Sie nicht vorhaben, es zu teilen oder jemand mit anderen daran zu arbeiten Sie (hoffentlich) frei, jede Art der Programmierung/Konvention zu verwenden, ist pep08 keine Religion, aber wenn jemand anderes muss jemals an deinem Code arbeiten, er wird dich sicherlich dafür hassen, dass er auf diese Weise kommentiert.

Answer 2

Diese Frage ist ein Duplikat von this question
Sie könnten auch mehrzeilige Kommentare wie diese verwenden.

""" 
This is how yo can use Python Multi-line Comments 
Line two is here. 
Line three is here. 
"""