[PYTHON] Ich möchte, dass Sie wissen, was wir ab dem nächsten Jahr gemeinsam entwickeln werden. (Aus "Lesbarer Code")

Berühmte "Lesbarer Code - einfache und praktische Techniken zum Schreiben von besserem Code" (http://www.amazon.co.jp/ Lesbarer Code --- Einfache und praktische Techniken zum Schreiben von besserem Code -Theorie-Praxis-Boswell / dp / 4873115655) wird kurz gelesen, und ich werde zusammenfassen, was ich wollte, dass die Junioren, die sich mit mir entwickeln, wissen.

(In diesem Buch werden Python, JS, Java und C ++ als Beispielcode verwendet.)

Prinzip

"Der Code sollte leicht zu verstehen sein"

Cool / kurz ≠ leicht zu verstehen / zu lesen

Oberflächliche Organisation

• Füllen Sie den Variablennamen / Funktionsnamen genau mit Informationen
• Teilen Sie die Variablendeklaration in sinnvolle Gruppen ein und fügen Sie jeder Gruppe Kommentare hinzu.
• Schreiben Sie nicht bewusst Kommentare (offensichtliche Inhalte), die nicht geschrieben werden sollten
• Klären Sie "Ihre Gedanken" und "Gründe, um zu dieser Schlussfolgerung zu gelangen", wenn Sie den Code schreiben
• Der Teil, der nichts mit dem Wesen der Logik zu tun hat, zeigt es deutlich
• Beantworten Sie Fragen, die Sie unbedingt in den Kommentaren stellen
• Geben Sie für komplexe Funktionen anhand eines Beispiels ein Bild der Eingabe / Ausgabe.
• Erklären Sie die Funktion (was Sie tun), nicht die programmatische Bedeutung

Vereinfachung der Logik

• Teilen Sie große Dinge in Größen, die leicht zu essen sind (leicht zu verdauen beim Lesen)
• Variablen unveränderlich machen
• Setzen Sie keine nutzlosen Variablen
• Unterscheiden und trennen Sie wesentliche Logik von nicht verwandter Unterverarbeitung
• Wrap ohne Kompromisse auf einer nicht idealen Schnittstelle
• Exportieren und organisieren Sie Aufgaben und mischen Sie nicht mehrere Prozesse gleichzeitig
• Halten Sie den variablen Bereich klein

Erläuterung

• Versuchen Sie laut zu erklären, was Sie in diesem Teil tun
• Konzentrieren Sie sich auf die in der Erklärung verwendeten Schlüsselwörter
• Versuchen Sie erneut, die Funktionen zu erklären und zu organisieren

Natürlich ist es ein Programmierbuch, aber es gibt einige Teile (glaube ich), die ziemlich eng mit den Tipps der Präsentation verbunden sind. Letztendlich denke ich, dass es darum geht, darüber nachzudenken, was Sie tun können, um die Verständungszeit der anderen Partei zu verkürzen.