Quelltextformatierung

Programmierung

Als Quelltextformatierung bezeichnet man Formatierung Eines sterben Quelltexts nach Bestimmt Regeln. Zweck ist das Verbessern der Programmcode-Lesbarkeit, die das Funktionalitätsprogramm des Programms besitzt, ist davon nicht.

Quelltextformatierung ist als Funktion in einigen integrierten Entwicklungsumgebungen enthalten und wird von der Quelltext angewendet. There ist aber Auch Eigenständiges Programm , so genannten Quelltext-Formatierer (engl. Quelle Format oder Auch beautifier ), sterben sie SIE Programmierer ermöglichen, BEREITS vorhandene Quelltext in einem gut BZW. besser lesbares Format zu bringen.

Die Anwendung einer Quelltextformatierung ist besonders nützlich, wenn die Programmiersprache einen vordefinierten programmierbaren Parameter hat, um den Quelltext zu gestalten.

Insbesondere bei Programmiersprachen, Die Eine C -ähnliche Syntax hat, z. B. C ++ , Java , C # , ist das Quelltextformatierung weit breit.

In den Programmiersprachen F # , Elm , Python , Occam und nur anderen sind Quelltextformatierung ein Syntaxelement. Blöcke war hier in der Mitte der Festung, durch eine syntaktische Bedeutung.

Beispiel für Quelltext-Formatierer Sind Die Freie Programm indent und Astyle . Auch Editor Wie Emacs oder Vim verfügen intern über entsprechende Formatierungshilfen, ebenso Wie Visual Studio .

Vorteile der Quelltextformatierung

  • Einhaltung Eines Programmierstil (engl. Code – Konvention )
  • Vereinigunglichkeit des Quelltextlayouts
  • Erhohung der Lesbarkeit
  • Erhohung der Wartbarkeit

Die Quelltextformatierung hat zum Ziel, Programmierer Arbeit mit Quelltexten zu erleichtern, Besondere Übernahme von Quelltexten Andere Programmierer oder der Arbeit in Teams. Unique Quasigenormte Varianten findet diesen Artikel Einrückungsstil .

Änderungen bei der Quelltextformatierung

  • Einheitlichkeit der Einrückung, Einhaltung eines bestimmten Einrückungsstils
  • Entfernt oder Hinzufügen von Block bei modifizierenden Anweisungen Wie if, else, for, while, dousw.
  • Vereinigunglichkeit von Leerzeichen vor der Argumentliste, z. B.
    • Leerzeilen vor den Argumenten modifizierender Anweisungen,
    • keine Leerzeichen vor den Argumentlisten von Funktionsaufrufen oder
    • keine Leerstellen vor der Parameterliste einer Funktionsdeklaration.
  • konsequente Positionierung der {} für Blöcke
  • Einfügen von () gemäß der Betreiberpriorität an den Betreiber, was im Allgemeinen eine Priorisierung ausschließt

Weitergehende Algorithmen zur Quelltextformatierung Beherrschen

  • Vereinigunglichkeit von Symbolnamen
  • Umbenennung von Symbolen nach dem Übereinkommen, z. B. m_MainControl in mainControl
  • Ergänzung von Rümpfen für Dokumentationskommentare
  • Übersetzung von Code-Analysewerkzeuge, bis hin zum Vorschlag von Refaktorierungen

Beispiele für die Arbeitsweisen

Ausgangsquelltext:

 für ( int i = 0 ; i < 10 ; i ++)
 if ( Werte [ i ]> 0 && Werte [ i + 1 ]> 0 )
 {
 out . println ( "gefunden!" );
 Pause ;
 }

Ergebnis der Formatierung:

für ( int i = 0 ; i < 10 ; i ++) {
 if ( Werte [ i ] > 0 && Werte [ i + 1 ] > 0 ) {
 out . println ( "gefunden!" );
 Pause ;
 }
}

Änderung:

  • Grundsätzliche Blöcke hinter für, wenn du. Ä. Auch wenn Einzelanweisungen erlaubt sind (erledigte leichte Erungen von Anträgen im Block)
  • Die Einrückung wurde Folgevereinbarkeit (auf jou 4 Leerzeichen)
  • Awesome schweiffift Für eine grössere Darstellung klicken Sie auf das Bild. Sail (ein weiterer Stil in Java und C ++)
  • auflockernde Leerzeichen wurde nach Regelsatz:
    • Hinter Schlüsselwörtern wer wenn, während …
    • kein Leerzeichen hinter geöffneten und geschlossenen Klammern (analog eckige Klammern)
    • Raum zwischen binären Operatoren (solche mit zwei Operanden)

Auch wenn der dargestellte Stil – z. B. in der Java-Programmierung [1] – relativ verbreitet ist, gibt es eine Vielzahl von anderen Stilen, die teilweise durch die Tradition, Teil durch die Eigenschaften der Jeweiligen Programmiersprache begruendet sind.

Nachteile des Einsatzes

Programme, die die Quelltextformatierung durchführen, sind nicht in der Lage, die Menschen die Bedeutung eines Quelltextes zu erfaßen. Die Regeln für die Umformatierung sind sehr schemisch und ausdruckslos. Angesichts der Vorurteile hat das Ziel der Verständlichkeit Vergesenkens gegenüber die Umformatierungsregeln zu Grunde liegende Convenies verloren. beispiel:

int width = minimale Breite * 2 + padding * 4;

Unter Umständen zu

int width = minimale Breite * 2 + padding * 4;

Es Konventionsverstoß Dezember Programmierer dienen offensichtlich sie Zweck, stirbt Verständlichkeit des Programm zu erhöhen, ist INDEMAR Durch das weglassen von Leerzeichen Bildenden höherer Priorität wo Multiplikation (*) im Vergleich zur Addition (+) zum Ausdruck Bricht sterben. In der Quelltextformatierung ging die Information verloren. Ist die Bedienerrangfolge nicht endgültig erkennbar, wurden die Fehler vermieden.

Wenn wir das sagen möchten, möchten wir sagen, dass der „Persönliche Stil“ eines Programmierers zerstört wurde. Das Kann meist entgegengesetzt Wird that es beim Programmierer im auf den Stil und persönlichen Das Team nicht Ego einzelnes ankommen, Sondern Darauf, Dass sie Teams als ganzes ein angenehmes und zügiges Arbeiten Werden soll ermöglicht. Das ist eine gute Idee, und Sie sind willkommen, Sie sind herzlich eingeladen, das Team und Ihr Team zu sehen.

Einzelstunden

  1. Hochsprünge↑ Code Conventions für die Programmiersprache Java. In: oracle.com , Sun Microsystems , 20. April 1999. (Englisch)