Annahme
Ich habe gerade mit dem Programmieren begonnen (1~2 Monate) Ich habe zusammengefasst, was ich gelernt habe.
Es kann Dinge geben, die nicht funktionieren oder auf dem tatsächlichen Gebiet falsch sind.
Wenn Sie es bemerken, lassen Sie es uns bitte in den Kommentaren wissen.
Ich bin ein Anfänger in der Programmierung
Sie müssen einfach zu lesenden Code schreiben
Wie kann ich leicht verständlichen Code schreiben?
Ich habe zusammengefasst, was ich gelernt habe.
Es gibt drei Hauptgründe, einfach zu lesenden Code zu schreiben. ・ Erhöhte Produktivität von Einzelpersonen und Organisationen ・ Verbesserte Wartbarkeit ・ Ein flexibles Entwicklungssystem kann aufgebaut werden Da die Entwicklung durch Programmierung im Wesentlichen von mehreren Personen durchgeführt wird, erreicht die Produktivität ein Plateau, wenn Sie sich nur selbst kennen müssen, und Sie sind weit entfernt von einem flexiblen Entwicklungssystem.
** Refactoring ** wird durchgeführt, um diese drei zu erreichen. Was ist Refactoring? Der Quellcode soll so verbessert werden, dass er leicht zu lesen ist, ohne die implementierten Funktionen zu beeinträchtigen. Dieses Refactoring erleichtert Mitentwicklern das Verständnis und die Änderung des implementierten Codes.
Die Variable wird unter Berücksichtigung anderer benannt (Name der Variablen und Funktion) Einfach zu lesen ohne komplizierte Logik (Vereinfachung der Logik) Kommentare sind enthalten und Sie können den Code lesen, während Sie das gesamte Bild erfassen (genaue und unkomplizierte Kommentare).
Vermeiden Sie beim Benennen von Variablen und Funktionen abstrakte Namen und geben Sie ihnen konkrete Namen. Für Variablennamen Definieren Sie den Wert, damit Sie sehen können, welche Rolle die Variable spielt. Für den Funktionsnamen Definieren Sie, was zu tun ist, in Form von Verb + Substantiv, damit Sie verstehen, was zu tun ist.
schlechtes Beispiel
const one = 1;
Gutes Beispiel
const userId = 1;
In einem schlechten Beispiel sagt uns der Name der Variablen nicht, was der Wert 1 ist und welche Rolle er spielt. In einem guten Beispiel sehen Sie auf einen Blick, dass die Variable userId und der Wert 1 die Benutzer-ID ist.
schlechtes Beispiel
const add = () => {
wird bearbeitet
};
Gutes Beispiel
const addTask = () => {
wird bearbeitet
}
In einem schlechten Beispiel weiß ich, dass ich etwas hinzufüge, aber ich weiß nicht, was ich hinzufügen soll. In einem guten Beispiel ist Task angehängt, sodass Sie auf einen Blick verstehen, dass es sich um einen Prozess zum Hinzufügen von Task handelt.
Es gibt zwei Hauptfaktoren, die den Code komplizierter machen. Wenn es eine Beschreibung der Verschachtelung in der Verschachtelung gibt Wenn der bedingte Ausdruck kompliziert ist
Was ist ein Nest? Verschachtelung ist eine verschachtelte Struktur. Wenn Sie es mit einem bedingten Ausdruck vergleichen, wird gesagt, dass die Verschachtelung tief ist, wenn die Beschreibung wie wenn in wenn und wenn in diesem wenn. Dies bedeutet, dass es viele verschachtelte Strukturen enthält.
Wie Sie in diesem Beispiel sehen können, wird die Struktur umso komplizierter, je mehr Strukturen in einer Struktur vorhanden sind. Dies bedeutet, dass es einfacher ist, den Code zu lesen, wenn Sie während der Verschachtelung so wenig Nester wie möglich schreiben. Spezifische Gegenmaßnahmen
Selbst wenn der bedingte Ausdruck lang ist, ist er schwer zu verstehen, da Sie ihn von Anfang bis Ende lesen müssen, um den Inhalt des Prozesses zu verstehen.
Wenn die Beschreibung des bedingten Ausdrucks lang wird, können Sie den Code präziser und verständlicher gestalten, indem Sie den bedingten Ausdruck als Funktion schreiben und die Beschreibung aufrufen.
Trotzdem ist es kompliziert, weil die Beschreibung mehrere bedingte Ausdrücke enthält. In diesem Fall kann die Beschreibung vereinfacht werden, indem mehrere bedingte Ausdrücke zerlegt und in mehrere ifs unterteilt werden.
Sie können einen Kommentar im Code hinterlassen, indem Sie ihn auskommentieren. Sie können diesen Kommentar verwenden, um die Beschreibung verständlicher zu machen.
・ Wenn Sie komplizierte Logik schreiben, hinterlassen Sie in den Kommentaren einen Überblick über den Prozess und Ihre Gedanken. ・ Lassen Sie, warum eine solche Beschreibung gemacht wird
・ Ergänzender Kommentar
Dies sind die Grundregeln, die ich beachten sollte, wenn ich leicht verständlichen Code schreibe, den ich als Anfänger in der Programmierung gelernt habe. Wenn Sie Ergänzungen oder Korrekturen haben, hinterlassen Sie bitte einen Kommentar.
Recommended Posts