Zum Beispiel nicht vertikal ausgerichtet:
Name: Hamt
Version: 0.1.0
Cabal-Version: >= 1.2
License: BSD3
Author: Jason Baker
Oder vertikal ausgerichtet:
Name: Hamt
Version: 0.1.0
Cabal-Version: >= 1.2
License: BSD3
Author: Jason Baker
Welches bevorzugen Sie und warum?
Antworten:
Persönlich bin ich der Meinung, dass die zweite Version des Codes geringfügig besser lesbar ist, aber ich denke nicht, dass die Beibehaltung diese Lesbarkeit wettmacht. Daher würde ich die zweite Version dieses Beispiels nur verwenden, wenn ich ziemlich sicher wäre, dass sich der Code nicht ändern würde.
Ich bevorzuge einen Hybrid:
Name : Hamt
Version : 0.1.0
Cabal-Version : >= 1.2
License : BSD3
Author : Jason Baker
Dies ist im Wesentlichen die Nummer 2 mit Ausnahmen für gelegentliche Linien, die länger als die umgebenden Linien sind - um zu verhindern, dass die Mehrheit der Linien einen großen Abstand zueinander hat.
Hier ist eine weitere Variante für Listenlayouts, die sowohl auf Erfahrung als auch auf der Ausbildung eines Universitätskurses basiert, den ich zur Mensch-Computer-Interaktion absolviert habe, sowie auf mehreren Büchern, die ich über (G) UI-Design und Grafikdesign gelesen habe. Ich benutze es für Dialoge und, wenn ich die Energie / Zeit habe, für CSS (normalerweise jedoch nicht für Code).
Name : Hamt
Version : 0.1.0
Cabal-Version : >= 1.2
License : BSD3
Author : Jason Baker
Wie alle anderen hat es Vor- und Nachteile.
Vorteile:
Nachteile:
HTH
Ich bevorzuge den ersten, aber ohne die Tabulatoren (von denen ich denke, dass die Leerzeichen sind); Stattdessen nur ein Leerzeichen. Für mich ist das leichter zu lesen, wenn die Daten nicht "ähnlich" sind, wie im gegebenen Fall. Es macht es auch schwieriger (während der Bearbeitung solcher Daten), "eine Zeile falsch zu lesen", dh wenn Sie drei Zeilen mit beispielsweise Versionsnummern haben. Und während Sie eines bearbeiten, bearbeiten Sie versehentlich ein anderes an seiner Stelle.
Wenn die Daten jedoch ähnlich sind, ist es durchaus sinnvoll, sie wie in Ihrem zweiten Beispiel in Spalten einzuteilen (nur, dass sie nicht ähnlich sind, aber Sie verstehen, worum es geht).
Da dies leider eine Stilfrage ist, ist dies sehr subjektiv und Sie werden wahrscheinlich viele widersprüchliche Ergebnisse haben. Darüber hinaus hängt der zu verwendende Stil stark von der Verwendung von Tabulatoren oder Leerzeichen ab.
Für meine zwei Cent bevorzuge ich eine Variante der zweiten Version. Das gefällt mir am besten:
Name : Hamt
Version : 0.1.0
Cabal-Version : >= 1.2
License : BSD3
Author : Jason Baker
Es ist die lesbarste und benutzerfreundlichste Version, die ich ausprobiert habe. Der einzige wirkliche Nachteil ist, dass ich herausfinden muss, was das breiteste Feld ist, und manchmal alle erweitern muss, wenn eines zu breit ist (dies passiert normalerweise nur mit CSS). Es gibt jedoch einige Punkte, die berücksichtigt werden müssen.
Erstens bevorzuge ich normalerweise Tabulatoren im Gegensatz zu Leerzeichen, wobei die tatsächliche Einstellung der Tabulatoren jedoch variiert. Ich bin zum Beispiel an 4-Leerzeichen-TABs für C (++) - oder HTML- und 2-Leerzeichen-TABs für Pascal- oder Assembler-Code gewöhnt, während ich für einige Dinge wie CSS die TAB-Breite nicht bevorzugt habe. Diese Variante kompliziert die Dinge genug, aber dann wirft der von mir verwendete Editor seine eigenen Komplikationen auf. In einigen Editoren können Sie sprachspezifische TAB-Einstellungen festlegen, in anderen jedoch nicht (selbst bei einigen mit unterschiedlichen Profilen).
Sie können diese Komplikation vermeiden, indem Sie auf Tabulatoren zugunsten von Leerzeichen verzichten. Da Code in der Regel eine Schriftart mit fester Breite hat, funktioniert die Verwendung von Leerzeichen problemlos. Wenn Sie hingegen Felder in einem Formular, einem Lebenslauf oder anderem Text formatieren, der kein Code ist, und eine proportionale Schriftart verwenden, benötigen Sie Tabulatoren, um die Ausrichtung zu gewährleisten .
Ich bevorzuge TABs im Allgemeinen, weil ich es selbst bei Code mit fester Breite frustrierend finde, für jedes TAB durch mehrere Leerzeichen navigieren zu müssen. Ich erinnere mich, dass die alten Borland-IDEs die Option hatten, durch Tabulatoren (insbesondere ganze Längen von Leerzeichen) als einzelne Entität anstatt als zwei, vier usw. Leerzeichen zu navigieren. Das machte es praktisch, Tabulatoren als Leerzeichen einzufügen, während die Cursornavigation einfach und schnell war. Leider habe ich keine modernen Windows-Editoren gesehen, die das können.
Schließlich spielt es bei der Wahl des Stils eine große Rolle, ob andere Ihren Code verwenden oder nicht. Normalerweise bin ich der Einzige, der meinen Code verwendet, sodass ich alles nach meinem Geschmack formatieren kann, ohne auf die Editoren oder Einstellungen anderer zu achten. Wenn Sie mit anderen zusammenarbeiten, müssen Sie diese berücksichtigen, da sie Sie berücksichtigen müssen.
Zusammenfassend ist die Lesbarkeit gut und sehr wünschenswert. Die Einstellungen und Editoren, die Sie und andere zur Verwendung des Codes benötigen, sind jedoch wichtig, wenn Sie eine Entscheidung treffen. Wenn Sie alleine sind, können Sie auch nur das am besten lesbare Format verwenden. Möglicherweise müssen Sie sich an die Verwendung des Codes gewöhnen, aber es wird sich auf lange Sicht auszahlen, insbesondere wenn Sie zu dem Code zurückkehren müssen, den Sie vor einiger Zeit geschrieben haben: Die Lesbarkeit ist genauso wichtig wie Kommentare, um die Funktionsweise des Codes zu verstehen. Wenn Sie mit anderen zusammenarbeiten, sollten Sie zusammenarbeiten, um eine Art Design-Leitfaden für das Team zu erstellen.
:%s/\([^ ]\) \+/\1 /g