2014-02-05 9 views
8

PEP-8 Zustände:Warum schlägt pep8 zwei Leerzeichen in Kommentaren vor?

Sie zwei Räume nach einem Satzende Zeitraum verwendet werden soll.

In meinem üblichen Refactoring, ich solche aufeinanderfolgende doppelte Leerzeichen zu ersetzen mit einem einzigen verwendet denke, dass diese Gewohnheit von den Schreibmaschine Tage gekommen ist (ich habe ging durch this Wikipedia page kurz).
Auch die meisten Male habe ich mono-Space-Fonts für die Programmierung verwendet, so ist es viel klarer als die anderen Fälle, die manchmal 2 Leerzeichen benötigen, um Sätze zu identifizieren.

Gibt es einen Grund dafür, dass PEP-8 verwendet wird?

+0

Wenn Ihr in der PEP8 Link zu dem Satz sich beziehen: ‚Sie zwei Leerzeichen nach einem Satz endende Periode verwenden sollten‘ Sie ausdrücklich diesen Satz schreiben soll verhindern Mehrdeutigkeit mit Zeilenabstand oder Schriftarten (die Sie auch erwähnen). – joaquin

+0

Ich kann dir nicht sagen, wie sehr es mich stört, dass dein Satz nicht in einer Periode endet. – asmacdo

+1

@asmacdo: Es war im vorherigen Update verloren (nicht von mir). Ist der neu hinzugefügte Zeitraum glücklicher :)? – 0xc0de

Antwort

5

Nur wer den PEP verfasst hat, kann das "Warum" mit einiger Sicherheit beantworten.

Ich habe mir die standard library source code angesehen, und meine Schlussfolgerung ist, dass dieser bestimmte Aspekt des Styleguides nicht konsequent gefolgt wird: einige Standardmodule folgen ihm und andere nicht.

Bis Sie darauf hingewiesen haben, habe ich noch nie von der doppelten Raumkonvention gehört, und habe nie bemerkt, dass jemand ihr folgt.

+0

Sogar ich hatte diesen Teil des Pep8 noch nie bemerkt. Ich habe immer einzelne Leerzeichen verwendet und keines (einschließlich Linters) beanstandet. Während ich einige andere Richtlinien für Kommentare nochmals überprüfte, bemerkte ich es. Ich denke, es ist keine strenge Empfehlung, und kann ignoriert werden, wenn ich nicht überzeugt bin. – 0xc0de

2

Die Antwort ist einfach: Lesbarkeit :)

+0

Mit mono-spaced Schriftarten, Die Sätze sind leicht zu erkennen und der Code/Kommentare sind auch als die Interpunktion wie "." oder "," nehmen den gleichen horizontalen Abstand wie jedes andere Zeichen (oder Leerzeichen) und der vorangehende Abstand lässt die Lücke breiter erscheinen als ein einzelnes Leerzeichen. Stattdessen sind meine Augen ein bisschen genervt, zwei oder mehr Leerzeichen in einem Absatz zu sehen, und das Schreiben eines solchen Kommentars ist auch etwas mehr Arbeit. – 0xc0de

+1

Wie verbessert es die Lesbarkeit? http://www.slate.com/articles/technology/technology/2011/01/space_invaders.html –

+1

@ Clément Wie der Artikel sagt, sind zwei Leerzeichen nach einem Satz besser lesbar für monospaced Schriftarten, die oft für die Anzeige oder verwendet werden Code bearbeiten. –

1

Die Argumentation hinter dem doppelten Raum existiert noch im Code.

Für Leute, die glauben, dass zwei Leerzeichen die Lesbarkeit verbessern, ist die Argumentation in Bezug auf WYSIWYG-Editoren mit Kerning weniger relevant geworden. Der Code wird jedoch in Fonts mit gleichem Abstand geschrieben, was bedeutet, dass Sie, wenn Sie mehr Platz zwischen den Sätzen haben möchten, ihn dort einfügen müssen.

aber sagen, dass ich lieber einzelne Leerzeichen :)

Verwandte Themen