Was bedeutet es, “ guten Code ” zu schreiben? [geschlossen]

Es gibt wirklich keine anderen guten Kriterien als wie schnell Sie den Code verstehen können. Sie sorgen dafür, dass Ihr Code gut aussieht, indem Sie den perfekten Kompromiss zwischen Prägnanz und Lesbarkeit finden.

Die „WTF“ pro Minute „(oben) ist wahr, aber es ist nur eine Folge der allgemeineren Regel. Je mehr WTFs vorhanden sind, desto langsamer ist das Verständnis.

Kommentare

• @rmx: Definieren Sie ", um den Job auszuführen gut "
• Nun, dass die RemoveCustomer -Methode das Cutomer tatsächlich entfernt, ohne es zu vermasseln. Sie können Stunden damit verbringen, es hübsch aussehen zu lassen, aber das bedeutet nicht, dass es tatsächlich funktioniert. ' Wie schnell Sie Code verstehen können ' ist nicht das einzige Kriterium für ' guten Code ' ist das, was ich ' sage.
• @rmx: aber fehlerfrei zu sein ist impliziert, isn ' nicht wahr? Wenn Ihr Code ' den Job nicht ordnungsgemäß ausführt, ist ' (noch) kein Code.
• @ rmx: in der Tat nein. Wenn Ihr Code leicht zu verstehen ist, ist ' leicht zu verstehen, wenn er ' schlecht funktioniert. OTOH, wenn es ' schwer zu verstehen ist, ist es ' schwer zu verstehen, wenn es dies tut ' s Job überhaupt.
• @rmx: PS Einfach ausgedrückt ist Ihr decrement () eine klassische WTF und verlangsamt somit das Verständnis von Teilen des Codes, in denen diese Funktion verwendet wird.

Sie wissen, dass Sie guten Code schreiben, wenn …

1. Der Kunde ist zufrieden
2. Kollegen leihen Ihren Code als Ausgangspunkt aus
3. Dem brandneuen Mann wurde gerade gesagt, er solle Änderungen an einem System vornehmen, das Sie vor 6 Monaten gebaut haben, und er / sie hat Ihnen nie eine Frage gestellt.
4. Ihr Chef bittet Sie, neue Widgets für zu entwickeln Das zu verwendende Team
5. Sie sehen sich den Code an, den Sie heute schreiben, und sagen sich: „Ich wünschte, ich hätte vor zwei Jahren einen solchen Code geschrieben.“

Wie geht es Ihnen? Messen Sie, ob der Code gut ist …

• Wie lange dauert die Antwort?
• Wie viele Roundtrips zum Server werden durchgeführt?
• Würden Sie die Anwendung persönlich verwenden oder denken Sie, dass sie klobig ist?
• Würden Sie sie beim nächsten Mal auf die gleiche Weise erstellen?

Guter Code funktioniert, wenn es so ist sollst. Guter Code kann bei Bedarf leicht geändert werden. Guter Code kann wiederverwendet werden, um Gewinn zu erzielen.

Kommentare

• " Der Kunde ist zufrieden " ist orthogonal dazu.
• @TRA – Wenn der Kunde zufrieden ist, bedeutet dies, dass Sie die Anforderungen verstanden und eine erwartete Lösung bereitgestellt haben.
• Sicher, aber schlechter Code kann dasselbe tun.

Ein Code, der

heißt guter Code.

Ein gutes Programm funktioniert einwandfrei und weist keine Fehler auf. Aber welche inneren Qualitäten erzeugen eine solche Perfektion? Es ist kein Rätsel, wir müssen nur gelegentlich daran erinnert werden. Egal, ob Sie in C / C ++, C #, Java, Basic, Perl, COBOL oder ASM codieren, jede gute Programmierung weist dieselben bewährten Eigenschaften auf: Einfachheit, Lesbarkeit, Modularität , Schichtung, Design, Effizienz, Eleganz und Klarheitseffizienz, Eleganz und Klarheit

Quelle: MSDN

Kommentare

• Einfachheit, Lesbarkeit, Eleganz und Klarheit sind alle dasselbe. Modularität und Überlagerung sind nur Methoden, um Ihren Code klar zu machen und elegant. Das einzige, was in der Liste noch übrig ist, ist Effizienz, was irgendwie impliziert ist, und außerdem geht es oft darum, Kompromisse zwischen Effizienz und Klarheit einzugehen.
• Überprüfen Sie Folgendes: goo.gl/hdQt8
• Code kann fehlerfrei sein?
• Nein, ' t. (Praktisch)
• Effizient sollte zu Ihrer Liste hinzugefügt werden. Geschwindigkeit ist ' nicht erforderlich Dies ist zwar ein Hauptindikator für guten Code, aber guter Code sollte ' nicht unnötig langsam oder verschwenderisch sein.

Kommt Ihnen das bekannt vor?

Philips gab mir die Möglichkeit, das Design eines neuen Produkts zu beobachten. Als es sich entwickelte, wurde ich zunehmend unruhig und begann, meine Bedenken meinem Vorgesetzten anzuvertrauen. Ich sagte ihm wiederholt, dass die Designs nicht „sauber“ seien und dass sie „schön“ sein sollten, so wie Dijkstras Designs schön waren. Er fand dies keinen nützlichen Kommentar.Er erinnerte mich daran, dass wir Ingenieure waren, keine Künstler. In seinen Gedanken drückte ich einfach meinen Geschmack aus und er wollte wissen, nach welchem Kriterium ich mein Urteil fällte. Ich konnte es ihm nicht sagen! Da ich nicht erklären konnte, gegen welche Grundsätze verstoßen wurde, wurden meine Kommentare einfach ignoriert und die Arbeit ging weiter. Als ich spürte, dass es einen Weg geben muss, meinen „Geschmack“ zu erklären und zu motivieren, versuchte ich, ein Prinzip zu finden, das gute von schlechten Designs unterscheidet. Ingenieure sind sehr pragmatisch; sie mögen Schönheit bewundern, aber sie suchen Nützlichkeit. Ich habe versucht, eine Erklärung dafür zu finden, warum „Schönheit“ nützlich ist.

Den Rest finden Sie hier .

Kommentare

• Da der Link im Beitrag von @mlvljr ' fehlerhaft ist Hier ist ein Link zur Google Books-Seite: books.google.co.in/…
• @balajeerc Danke (Ich habe auch den Link repariert, sodass er auf eine von Springer gehostete Version desselben PDFs verweist) 🙂

Abgesehen von den Qualitätskriterien für natürlichen Code (minimales Kopieren / Einfügen, keine Spaghetti usw.) sollte ein guter Industriecode immer ein bisschen naiv und ein bisschen zu ausführlich aussehen, wie

int key = i; const bool do_not_create = false; Record r = cache.get(key, do_not_create); ++i; 

im Gegensatz zu

Record r = cache.get(i++, false); 

Kommentare

• Aber bedeutet do_not_create = false „pass false als do_not_create Argument, damit es wird erstellt “oder„ pas s false als do_create Argument, damit es nicht erstellt wird „? In einer Sprache, in der Sie Argumentnamen verwenden können, würde ich cache.get (key:i, create: false); i += 1; bevorzugen.

Ich gehe einfach zu „wartbar“

Der gesamte Code muss gepflegt werden: Diese Aufgabe muss nicht schwieriger als nötig gemacht werden

Wenn ein Leser diese einfache Anforderung nicht versteht oder sie formulieren muss, sollte dieser Leser keinen Code schreiben …

Guter Code wird für jede Person unterschiedlich sein, und die Sprache, mit der sie arbeitet, wirkt sich auch auf die möglichen Aspekte aus guter Code sein. Wenn ich mich einem Projekt nähere, suche ich im Allgemeinen nach folgenden Dingen:

• Wie ist das Projekt organisiert? Sind Quelldateien sauber organisiert und kann ich Code ohne großen Aufwand finden?
• Wie ist der Code organisiert? Ist klar dokumentiert, was der Code in der Datei bewirkt, z. B. durch die Verwendung eines Dateikopfs oder durch die Verwendung jeder Klasse, die sich in einer eigenen Datei befindet? Gibt es Funktionen in der Datei, die nicht mehr in der Anwendung verwendet werden?
• Wie sind die Funktionen organisiert? Gibt es ein klares Muster für die Deklaration von Variablen oder ein ziemlich zufälliges Muster? Hat der Code einen logischen Ablauf und vermeidet unnötige Kontrollstrukturen? Ist alles klar dokumentiert, wobei der Code wo nötig selbstdokumentiert ist und Kommentare das Warum und / oder Wie des Codes klar ausdrücken?

Darüber hinaus ist das Design des Codes Anwendung als Ganzes sinnvoll? Der Code in der Anwendung kann der beste der Welt sein, aber es kann immer noch schwierig sein, damit zu arbeiten, wenn das Gesamtdesign der Anwendung keinen Sinn ergibt.

Lassen Sie mich der Lesbarkeit nicht zustimmen. Nein, nicht vollständig: Guter Code sollte lesbar sein, und das kann leicht mit genügend Kommentaren erreicht werden.

Aber ich betrachte zwei Arten von WTF: diejenigen, bei denen Sie sich fragen, ob der Programmierer weiter gekommen ist als das Programmieren von 101, und diejenigen, bei denen Sie die Genialität des Codes absolut nicht verstehen. Einige Codes können sehr seltsam aussehen Erstens, ist aber tatsächlich eine sehr erfinderische Lösung für ein schwieriges Problem. Die zweite sollte im WTF-Messgerät nicht zählen und kann durch Kommentare vermieden werden.

Sehr gut lesbarer Code kann sehr, sehr langsam sein . Eine weniger lesbare Lösung kann die Geschwindigkeit um ein Vielfaches verbessern. R ist ein großartiges Beispiel für eine Sprache, in der dies oft der Fall ist. Man vermeidet dort For-Loops so weit wie möglich.Im Allgemeinen würde ich den schnellsten Code als den besseren Code betrachten, obwohl er weniger lesbar ist. Das heißt, wenn die Verbesserung natürlich erheblich ist und genügend Kommentare eingefügt werden, um zu erklären, was der Code tut.

Darüber hinaus kann die Speicherverwaltung in vielen wissenschaftlichen Anwendungen von entscheidender Bedeutung sein. Code, der sehr gut lesbar ist, ist in der Speichernutzung eher schlampig: Es werden nur mehr Objekte erstellt. In einigen Fällen macht eine intelligente Speichernutzung den Code wieder weniger lesbar. Wenn Sie beispielsweise mit Gigabyte an DNA-Sequenzen jonglieren, ist das Gedächtnis ein entscheidender Faktor. Auch hier halte ich den weniger speicherintensiven Code für den besseren Code, unabhängig von der Lesbarkeit.

Ja, die Lesbarkeit ist also wichtig für einen guten Code. Ich kenne das Adagium von Uwe Liggis: Denken tut weh und Computer sind billig. In meinem Bereich (statistische Genomik) werden Rechenzeiten von einer Woche und eine Speichernutzung von über 40 GB jedoch nicht als abnormal angesehen. Eine Verbesserung der doppelten Geschwindigkeit und der Hälfte des Speichers ist also viel mehr wert als diese zusätzliche Lesbarkeit.

Kommentare

• Keine Regel / Regeln ausnahmslos
• Lassen Sie mich Ihrer Meinungsverschiedenheit nicht zustimmen: Sie sagen, dass Geschwindigkeit in Ihrem Bereich sehr wichtig ist und dass sie wichtiger ist als Lesbarkeit. Ich bin anderer Meinung, Sie sollten sich bemühen, die richtige Balance zu verwenden. Wenn keine Geschwindigkeit benötigt wird, zum Beispiel für eine High-Level-Schnittstelle, bevorzugen Sie möglicherweise etwas, das leicht zu warten ist. Wenn Geschwindigkeit benötigt wird, stimme ich Ihnen zu. Anstatt harte Regeln zu verwenden, ist es besser, den gesunden Menschenverstand zu verwenden, und Sie sollten ohnehin eine vorzeitige Optimierung vermeiden id = „668bace25d“>