So schreiben Sie guten und klaren Code: 3 einfache Möglichkeiten für einen Programmierer



Von einem Übersetzer: Heute veröffentlichen wir für Sie einen Artikel eines indischen Entwicklers, Ravi Shankar Rahan. Er spricht darüber, was zu tun ist, wenn Sie lernen möchten, wie man einfachen und verständlichen Code schreibt. Der Artikel wird allen unerfahrenen Programmierern empfohlen.

Das Schreiben eines einfachen Codes ist einfach. Aber wenn wir darüber sprechen, es für die zukünftige Verwendung durch jemanden vorzubereiten, wird alles sofort kompliziert. Tatsache ist, dass ein solcher Code noch sauberer und verständlicher sein sollte.

Der Entwickler muss einen Code erstellen, der von jedem seiner Kollegen aus jedem Land der Welt verwendet werden kann. So wird er so etwas wie sein „Erbe“. Das klingt alles gut und faltbar, aber die Realität sieht etwas anders aus ...

Skillbox empfiehlt: Zweijähriger Praktikumskurs "Ich bin ein PRO-Webentwickler . "

Wir erinnern Sie daran: Für alle Leser von „Habr“ - ein Rabatt von 10.000 Rubel bei der Anmeldung für einen Skillbox-Kurs mit dem Promo-Code „Habr“.

Tatsache ist, dass ich zu Beginn meiner Reise, obwohl ich das obige Dogma akzeptierte, einen so monströsen Code erstellt habe, dass er nicht als „gut“ bezeichnet werden konnte. Es war fast unmöglich zu verstehen und zu interpretieren. Wenig später begann ich Tage und Monate mit der „Korrektur“ und „Wiederbelebung“ der von mir geschaffenen Monster zu verbringen.

Es ist schwer zu programmieren. Wenn Sie ein Programm schreiben, in dem Zeilen enthalten sind, machen Sie Fehler. Manchmal sind sie bedeutsam, manchmal nicht sehr. Unabhängig von der Größe dauert es jedoch einige Zeit, sie zu finden und zu reparieren. Manchmal brauchen Sie Hilfe, um aus dem Trichter der Verzweiflung und Hoffnungslosigkeit herauszukommen, in den Sie bei der Arbeit an Ihrem Code geraten.

Manchmal brauchst du ... eine Gummiente

Das Konzept der Gummiente wurde zuerst von Dean Parker in seinem Beitrag zum Oratorium vorgeschlagen. Parker sagt, um ein guter Redner zu werden, muss man ständig üben, Reden zu halten. Und der beste Weg, um die Angst des Publikums loszuwerden und gleichzeitig zu lernen, Ihre Gedanken präzise und verständlich auszudrücken, besteht darin, während der „Redetrainings“ vor der Gummiente zu sprechen. Sie ersetzt nur das Publikum.

Als Programmierer müssen Sie versuchen, einer Gummiente (ob real oder imaginär) jede Zeile Ihres Codes zu erklären. Wenn Sie dies versuchen, beginnen Sie, die Stärken und Schwächen des Codes zu verstehen. Sie geben sich die Gelegenheit, ihn von der Seite anzusehen.

Hier sind einige wichtige Punkte, die ich bei der Anwendung dieser Praxis erkannt habe. Sie haben mir geholfen, merklich besser zu schreiben.

Das Erstellen wiederverwendbarer Komponenten ist keine dauerhafte Notwendigkeit

Viele sind anderer Meinung als ich und argumentieren, dass wiederverwendbare Komponenten immer benötigt werden, dass sie so oft wie möglich wiederverwendet werden müssen. Angenommen, dies hilft, die Qualität des Codes zu verbessern und an ihren eigenen Fehlern zu arbeiten. Das ist richtig, aber nur, wenn Sie den besten Code der Welt erstellen. Und niemand braucht ihn.

Nein, natürlich. Sie müssen Software erstellen, die bestimmte Bedingungen erfüllt, einschließlich des Budgets. Sie können Ihr Projekt auch ständig polieren, zum Leuchten bringen, Zeit verschwenden, sich aber wie ein idealer Entwickler fühlen. Aber denken Sie daran: Die Software ist für eine begrenzte Zeit relevant, was bedeutet, dass Sie schnell arbeiten müssen, sonst werden Sie nie fertig.

Du wirst es nicht brauchen

Das ursprüngliche englische Axiom klingt wie "YouArentGonnaNeedIt (YAGNI)". Sie sollten dies wie folgt verstehen: "Verwenden Sie bestimmte Tools nur, wenn Sie sie wirklich benötigen, und denken Sie nicht nur, dass sie für Sie nützlich sein können."

Dafür gibt es zwei Gründe:
  • Sie sparen Zeit, indem Sie unnötige Arbeit vermeiden.
  • Ihr Code wird besser, wenn Sie ihn vor den „vermeintlichen“ Elementen speichern, die das Programm erschweren würden.

Vereinfachen Sie alles auf ein Minimum

Extreme Programmierung hat zwei goldene Regeln zum Erstellen von einfachem Code.

Der einfachste Weg, eine neue Funktion einzuführen, besteht darin, sie „einfach funktionieren“ zu lassen. Keine Notwendigkeit, schicke Aufbauten zu schaffen, etwas Hightech. Lass einfach die Funktion funktionieren. Vergessen Sie jedoch nicht, dass der Code Unit Tests bestehen muss.

Zweitens , überarbeiten Sie das System so, dass der Code unter Einbeziehung aller aktuellen Funktionen so einfach wie möglich wird. Es sollte so sauber wie möglich sein.

Drittens lohnt es sich zu lernen, dass wir nicht nach dem schnellsten Weg suchen. Wir bemühen uns, das einfachste Ergebnis (in Bezug auf Code) zu erzielen. Sie können beispielsweise eine vorhandene Methode in Teile aufteilen, wodurch die Testfragmente funktionieren, und dann jede der Verarbeitungsmethoden Schritt für Schritt ändern.

Wenn Sie das nächste Mal stecken bleiben, versuchen Sie es mit Ente

Das Auffinden von Fehlern, Problemen und allgemeinen Arbeiten am Code ist der Hauptteil der Programmierung. Daher ist die Entwicklung eigener Techniken zur Suche und Beseitigung von Fehlern und zur Orientierung eine wichtige Aufgabe.

Wenn Sie irgendwo festsitzen und nichts funktioniert, versuchen Sie, sich zu ducken.

Sie können es sich nicht vorstellen, aber kaufen Sie es. Und es spielt keine Rolle, ob es sich um eine normale Ente für eine Badewanne oder eine Piratenente handelt - Hauptsache, Sie fühlen sich damit wohl, damit es zu Ihrer Persönlichkeit passt.

Und danach können Sie ein Gespräch mit einer Ente beginnen. Sprechen Sie mit ihr, stellen Sie Fragen, erklären Sie laut das Problem, mit dem Sie arbeiten. Das Ergebnis wird Sie überraschen.

Chris Pine hat zu Recht gesagt: "Programmieren ist nicht das, was Sie wissen, es ist das, was Sie lernen können."

Source: https://habr.com/ru/post/de434304/


All Articles