Warum ist Rich-Code-Formatierung nicht üblicher?


29

Ich las Code Complete und in dem Kapitel über Layout und Stil sagte er voraus, dass Code-Editoren eine Art Rich-Text-Formatierung verwenden würden. Das heißt, anstatt wie folgt auszusehen

Procedure ResolveCollisions
{ Performs a posteriori collision resolution through spatial partitioning algoritm }
(
  CurrentMap : SpriteContext,
  PotentialColliders: SpriteList
)
var Collider  : Sprite, 
    Collidee  : Sprite, 
    Collision : SpriteCollision
begin
  DoStuff();
end.

es könnte ungefähr so ​​aussehen:

Verfahren ResolveCollisions

Führt eine nachträgliche Kollisionsauflösung durch räumlichen Partitionierungsalgorithmus durch

Parameter

  • CurrentMap : SpriteContext
  • PotentialColliders : SpriteList

Lokale Variablen

  • Collider : Sprite
  • Collidee : Sprite
  • Collision : SpriteCollision
    DoStuff();

Ich habe Syntaxfarben und Hervorhebungen und sogar Klammern gesehen, aber nichts, was im tatsächlichen Code so aussah. Ich fragte mich, ob es so etwas überhaupt jemals gab, oder ob vielleicht entschieden wurde, dass es nicht genug Nutzen hatte oder dass es eine völlig schlechte Idee war.

Hat jemand von Ihnen schon so einen reich formatierten Code gesehen oder weiß er, ob die Idee jemals in Betracht gezogen und letztendlich abgelehnt wurde?


8
Hast du Knuths Web gesehen? www-cs-staff.stanford.edu/~uno/cweb.html
greyfade



12
Nun möchten Sie Word als IDE-Editor?

5
Sie haben sich noch nie mit Word gestritten, wenn es seltsame Formatierungen gibt, die einfach nicht zu beseitigen sind. In Ihrem Beispiel wird davon ausgegangen, dass der Editor einige Teile des tatsächlichen Quellcodes verbirgt. Als Zuschauer wäre es sicher nett, denke ich, als Redakteur, bitte ... erbarme dich meiner armen Seele!
Newtopian

Antworten:


38

Es gibt keinen technischen Grund, den Sie nicht konnten. Wenn Texteditoren Syntaxhervorhebungen durchführen können, können sie auch andere Aspekte der Anzeige ändern, um Code hervorzuheben.

Es ist jedoch eine Sache, dass das, was gerade eingegeben wird, die Farben ändert, wenn der Editor herausfindet, was Sie eingeben. Wenn sich die Größe des Textes plötzlich ändert und Sie während des Schreibens herumspringen, wird dies wirklich unangenehm.

Bei einer "statischen" Codeanzeige kann der Quellcode jedoch leicht verschönert werden. Nehmen Sie zum Beispiel einen halbwegs anständigen Quell-> HTML-Konverter und fügen Sie den Stylesheets beliebige Schriftgrößen und -stile hinzu, und Sie erhalten reichhaltigen formatierten Code.


14

Einfacher Grund: Editor- / Tool-Unabhängigkeit.

Sobald Sie Ihren Code "rich" gemacht haben, wird er an den von Ihnen verwendeten Editor gebunden oder an diejenigen, die Rich-Code verstehen können. Alle anderen Editoren, die mit dem Reichtum nicht umgehen können, zeigen Kauderwelsch.

Ebenso würde Rich Code nicht gut mit Diff-Tools funktionieren. Wenn Sie zum Beispiel nur eine Formatierung geändert haben, zeigt das Diff einen Unterschied, aber es ist nicht einmal ein Unterschied, mit dem Sie am wenigsten zu tun haben.

Und was ist mit der Versionskontrolle? Wie würden Sie es anweisen, alle Änderungen in der Formatierung zu ignorieren und Dateien nur dann als geändert zu betrachten, wenn es eine "echte" Änderung gibt?

Schließlich denke ich, der springende Punkt bei Rich Code ist die Lesbarkeit - und dafür denke ich, dass bessere (und mehr) Kommentare, logische Bezeichnernamen und konsistente Einrückungen ausreichen.

Im Wesentlichen wird der Programmiertext am besten als einfacher Text behandelt - was Sie sehen, ist die Realität. ( was auch mit der pythonischen Idee von explizit besser als implizit übereinstimmt )


28
Das ist nicht unbedingt wahr. Wenn Editoren Syntax-Hervorhebungen ausführen können, können sie sicher Syntax-Fettdruck oder Syntax-Schriftgrößen usw.
ausführen

4
Emacs kann dafür konfiguriert werden, aber IMO-Änderungen an der Schriftgröße würden Platz auf dem Bildschirm verschwenden.
Kevin Cline

4
Wenn der Autor die Formatierung manuell vornehmen müsste, wäre dies Zeitverschwendung. Es ist klar, dass der Texteditor dies automatisch erledigt, oder Sie könnten ein Stylesheet verwenden.
Peter Olson

7
@greegit: Editoren hinterlassen keine Farbinformationen in den Quelldateien, wenn sie damit fertig sind. Sie müssen keine anderen Formatierungsmarken hinterlassen und können diese bei Bedarf neu generieren. Es gibt keinen grundsätzlichen Unterschied zwischen Syntaxhervorhebung und Syntaxformatierung. Wenn Tools nützliche Klassendiagramme und UML-Diagramme automatisch aus dem Quellcode erstellen können, kann ein Tool von Zeit zu Zeit wirklich Mut machen.
Whatsisname

9
Diese Antwort hat sicher viele positive Stimmen, weil sie falsch ist.
Jordanien

11

Vielleicht hat sich reich formatierter Code nicht durchgesetzt, weil es keine so coole Idee ist. Persönlich gefällt mir nicht, was ich in dem von Ihnen bereitgestellten Beispiel sehe. Ich benutze Syntaxfärbung und -hervorhebung, aber diese Formatierung ist zu umständlich und weicht zu sehr von der Art und Weise ab, wie ich es gewohnt bin, Code zu sehen und zu schreiben.


11

Warum existiert es nicht? Es gibt keine Nachfrage / Notwendigkeit dafür.

Aktuelle Editoren sind in der Lage, die Bedürfnisse von Programmierern mit Syntaxhervorhebungen und einigen anderen kleineren Stiloptionen zu befriedigen. Ist das nicht schon "Rich Text"?


7
+1 Für keine Nachfrage. Ich würde es hassen, so zu programmieren. Anscheinend schreibe ich diesen TPS-Bericht in Word und schreibe keinen Code.

1
@Glenn Nelson: Dem stimme ich zu. Ich vermeide Word sogar zum Schreiben normaler Dokumente, wenn ich kann (ich verwende stattdessen LaTeX). Ich mag Syntax-Hervorhebungen, aber eine umfangreiche Code-Formatierung würde mich wirklich aufdringlich fühlen.
Giorgio

5

Dies gibt es bereits für LaTeX im AucTeX-Modus für Emacs. Abschnittsüberschriften sind größer, Unter- und Hochschriften werden entsprechend angepasst, und Sie können sogar eine kleine Vorschau der Mathematik (und möglicherweise anderer Umgebungen wie Algorithmic) anzeigen.

Dies ist für LaTeX in Ordnung, da die Zuordnung vom Code zur Ausgabe in der Regel viel einfacher ist als in anderen Programmen. Ich glaube, das würde mir für allgemeinere Sprachen überhaupt nicht gefallen.

Eine andere Sache , Emacs tun können , ist Symbole zu ersetzen , wie ->und forallmit und jeweils in Haskell. Es gibt kaum einen Grund, warum so etwas nicht auf die Formatierung ausgedehnt werden kann, die Sie vorschlagen, außer dass es in Haskell überhaupt nicht notwendig ist.


2

Vor einiger Zeit habe ich diese Frage zur Code-Formatierung gestellt und gefragt, ob Programmierer ihren Code während der Eingabe formatieren möchten.

Meine Frage bezog sich nur auf den Einrückungsaspekt der Formatierung, aber einige Antworten gelten möglicherweise auch für die Code-Formatierung im Allgemeinen. Das allgemeine Gefühl in den Antworten legt nahe, dass Programmierer dagegen sind, die absolute Kontrolle über die Art und Weise zu verlieren, in der ihr Code dargestellt wird.

Meine persönliche Erfahrung war ganz anders. Obwohl ich normalerweise öffentlich verfügbare Tools verwende, muss ich manchmal XSLT in meinem eigenen, maßgeschneiderten Editor schreiben. Dieser Editor formatiert den Code während der Eingabe, indem er am linken Rand eingerückt wird, sodass ich keine Probleme mit unerwünschten Leerzeichen habe (was für XSLT von Bedeutung ist). Außerdem kann der Code in Zeilenumbrüche umgewandelt werden und die Formatierung bleibt erhalten. Ich finde das Erlebnis ganz natürlich, der Formatierungsstil wird allein vom Kontext und der Position der Zeilenvorschübe bestimmt (das Erlebnis ist besonders lohnenswert, wenn Sie berührungsempfindliche Eingabegeräte verwenden).

Wenn das XSLT nicht ausgewogen ist, zeigt die Formatierung tatsächlich, wo das Problem liegt. Es hat eine Weile gedauert, bis sich der Code während der Eingabe horizontal verschoben hat, aber das ist für mich keine Ablenkung mehr. Ich habe jedoch festgestellt, dass Formatierungsfunktionen, die sich auf den vertikalen Abstand meines XSLT auswirken, den Editor nahezu unbrauchbar machen. Daher habe ich diese deaktiviert.

Um auf Ihre Frage zurückzukommen: Ich denke, der Grund, warum die Formatierung von Rich-Code nicht häufiger vorkommt, ist, dass es lange dauert, bis sich die Wahrnehmungen in der Programmierwelt ändern. Ihre Zeit wird möglicherweise mit der Zeit zusammenfallen, in der die Codebearbeitung überwiegend ohne Tastatur erfolgt.


2

Auch in mehr als ein paar Sprachen (Haskell, Ruby, Python, Erlang, CoffeeScript ein paar andere) ist Einrückung wichtig. Wenn Sie also die Schriftgröße ändern, kann es sehr schwierig werden, dies herauszufinden.

Meistens seine Tradition. Ich programmiere seit fast 20 Jahren professionell und ich vermute, das würde mich verrückt machen. Ich schreibe Bücher in Emacs oder VI mit docbook, also bin ich kein WYSIWIG-Fan


2

Knuths CWEB macht das, aber es funktioniert nur für C / C ++ und Pascal. - Du solltest es dir aber ansehen ... es ist ziemlich ordentlich. Es gibt zwei Programme: ctangleund cweavedie CWEB-Dateien in TeX bzw. C kombinieren / trennen.


1
nowebfunktioniert mit fast jeder möglichen Sprache. Darüber hinaus gibt es zahlreiche spezialisierte Programmiersysteme für Alphabetisierung, die auch für viele andere Sprachen verfügbar sind (sowohl für LHS- als auch für ALHS-Sprachen). Einige Sprachen verfügten ab Anfang der 1960er Jahre über eine
SK-logic

3
@ SK-logic - Arrgh, erinnere mich bitte nicht an den Horror, der darin besteht, dass ich gut programmiere . Verwandeln Sie jede schnelle Codeüberprüfung in eine mühsame und langwierige Dokumentüberprüfung , indem Sie jede letzte Wendung und jedes falsch platzierte Komma kritisieren. Warum einige Teile der Verteidigungsindustrie dies für eine gute Idee hielten, werde ich nie erfahren. Ich glaube nicht, dass WYSIWYG-Editoren es besser gemacht hätten.
Mark Booth

@ Mark Booth, alles kann zu einem Horror werden, wenn es falsch gemacht wird. Literarische Programmierung ist ein großartiges Werkzeug, wenn es mit einer angemessenen Disziplin kombiniert wird. Ich habe keine Ahnung, wie ich meinen Code mit komplexen Formeln, Plots und Diagrammen im TeX-Format ohne ein geschultes Programmiertool mit Anmerkungen versehen könnte. Und Code wird ohne solche Anmerkungen nicht mehr lesbar und wartbar sein.
SK-logic

2

Hat jemand von Ihnen schon so einen reich formatierten Code gesehen oder weiß er, ob die Idee jemals in Betracht gezogen und letztendlich abgelehnt wurde?

Sicher. Xcode unterstützt Stile jenseits der einfachen Farbgebung für unterschiedliche Syntax:

Quellcode mit gestyltem Text

Ich habe es schon lange nicht mehr benutzt, aber ich glaube, Metrowerks CodeWarrior hat auch gestalteten Text unterstützt, und das war vor über 10 Jahren.

Sie möchten die Stile jedoch nicht übertreiben - Text, Quellcode oder Ähnliches sind möglicherweise schwerer zu lesen, wenn die Stile zu stark variieren. Insbesondere finde ich, dass das Mischen von Größen störend ist, und alles, was dazu führt, dass Spalten nicht in einer Reihe stehen, ist ärgerlich. Es gibt einen Grund, warum die meisten Programmierer immer noch monospaced Schriftarten verwenden.

Eine andere Frage ist, ob formatierter Text als Teil der Sprachsyntax selbst verwendet werden soll. Soll der Compiler beispielsweise die Tatsache verwenden, dass ein Teil des Texts auf eine bestimmte Weise formatiert ist, um festzustellen, dass es sich bei dem Text um eine Funktionsdeklaration handelt? Das mag zunächst verrückt klingen, aber Sprachen wie Python und Fortran verwenden bereits Einrückungen als Syntax. Dennoch denke ich, dass es wahrscheinlicher ist, dass der Stil weiterhin von der Syntax bestimmt wird und nicht umgekehrt. Die Verwendung von einfachem Text (einfachere Compiler, Plattformunabhängigkeit, Programmiererpräferenzen) und andere Traditionen haben zahlreiche Vorteile, die es ermöglichen, Code ohne Stile (Einrückungen, Leerzeilen, Markierungszeichen und) lesbar zu machen Editorfunktionen wie Code-Faltung und Navigationsmenüs).


1

Ich denke, dass eine umfangreiche Formatierung des Quellcodes nicht sehr beliebt ist, da sie für die Eingabe von Informationen gedacht ist, bei denen Struktur und Bedeutung weitaus wichtiger sind (und auch einfacher zu tippen sind). Schrift, spezielle Symbole und Leerzeichen sorgen für unnötiges visuelles Rauschen. Dies kann jedoch für generierte Dokumentationen angemessen sein.

Es gibt nie endende Flammenkriege um dasselbe Thema in der Schriftsatzwelt zwischen denen, die WYSIWYG-Editoren (wie MS Word) und Systeme wie TeX (LaTeX) bevorzugen.

Im Allgemeinen gibt es keine endgültige Antwort. Alles hängt von Tools, Anwendungsfällen und persönlichen Vorlieben ab.


1

Tools wie Doxygen oder JavaDoc führen bereits die Formatierung von Rich-Text-Code durch. Sie fügen auch Code-Hypertext zum Durchsuchen hinzu. Sie müssen keine speziellen Tags für die Grundformatierung einfügen.

Dies ist jedoch kein WYSIWYG.


0

Ich habe Angst zu sagen, dass es das gibt.

In der Vergangenheit habe ich an einigen Centura gearbeitet (auch bekannt als Gupta oder SQL / Windows - ein alter " 4GL " Codes " -Code) gearbeitet. Es war nicht wirklich möglich, Centura-Code in einem Standard-Editor zu bearbeiten, wie es der Editor für die extremen Formatierungsanforderungen tut.

Obwohl es vielleicht so aussieht, als wäre es eine gute Idee, eine Quelldatei so formatieren zu lassen, empfand ich die Entwicklung als recht restriktiv und schmerzhaft.

Darüber hinaus verursachte die Formatierung häufig Probleme beim Zusammenführen in der Quellcodeverwaltung.


0

Zusätzlich zu den anderen Antworten möchte ich darauf hinweisen, dass es neben den technischen Schwierigkeiten bei der Verwendung einer umfangreichen Formatierung auch ein Objekt persönlicher Präferenz ist.

Wenn Sie einfachen Text bearbeiten, können Sie die gewünschten Schriftarten und Farben auswählen. Diese werden automatisch festgelegt. Wenn Sie Rich-Text bearbeiten möchten, was ist, wenn Sie bestimmte Farben und Schriftarten, die manuell festgelegt wurden, nicht mögen?


1
Ich denke nicht, dass das wahr ist. Ich bin mir ziemlich sicher, wenn Programmierer Rich-Text verwenden würden, gäbe es einen Generator, der eine Art semantisches Markup erstellt, das die Struktur des Programms beschreibt, und dann ein benutzerdefinierbares Stylesheet, das die Schriftart- und Farbinformationen enthält.
Peter Olson

@PeterOlson, dann können Sie ohne Ihr Stylesheet keine Programme lesen, da Sie die Bezeichnung von Textzeichenfolgen einfach nicht erkennen. Das bedeutet, dass niemand etwas zeigen oder schreiben kann, wenn er sich persönlich trifft. Im Gegenteil, Schriftarten und Farben sind derzeit völlig optional und ohne Beeinträchtigung der Bedeutung austauschbar.
Corvinus

0

Ich denke, das liegt daran, dass noch niemand das Lesen und Schreiben von Code getrennt hat. Zumindest wird es nicht zum Mainstream. Manchmal müssen Sie Code lesen, den Sie vor langer Zeit berührt haben, oder Code, der von anderen Entwicklern erstellt wurde. Sie müssen wahrscheinlich viel Zeit aufwenden, bis Sie bereit sind, ein einzelnes Byte in dieser Quelle zu ändern. Dies könnte der "Lese" -Modus sein, der alles tun kann, was zum leichteren Verständnis erforderlich ist (Schriftgröße, Neuformatierung, Unterskript, Superskript usw.). Wenn Sie bereit sind, kann der Editor in den "Schreib" -Modus wechseln und weniger restriktiv sein und die "Regel der geringsten Überraschung" befolgen.

Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.