Clean Code ist der Satz mehrerer Codekonventionen, die zusammen eine neue Art des Schreibens Ihres Codes schaffen, sodass er lesbarer, wartbarer, zuverl?ssiger und vorhersehbarer ist, was die Effizienz f?rdert und die Teamarbeit erleichtert .

Eines der vielen Prinzipien von sauberem Code besteht darin, Variablen mit Namen zu benennen, die selbstbeschreibend und selbsterkl?rend sind, um Mehrdeutigkeiten zu vermeiden und saubereren Code zu schreiben, sagte ein gro?artiger Autor ?Zeno Rocha in seinem Buch 14 Habits of Highly Productive Entwickler?wir sollten immer Code schreiben, den unser zukünftiges Selbst auch nach Jahren noch verstehen kann. Die Benennung von Variablen mit Verkleinerungsformen oder Abkürzungen kann zu unterschiedlichen Interpretationen führen, insbesondere zwischen Entwicklern mit unterschiedlichem Beteiligungsgrad am Projekt, was zu zukünftigen Problemen führen kann.

Wenn die Codebasis w?chst und ihre Variable au?er Acht gelassen wird, kommt es sehr h?ufig vor, dass die Notwendigkeit besteht, sie in Zukunft erneut zu betrachten, und eine schlechte Schreibweise wird es schwierig machen, Ihren Code zu verstehen, was hilfreich ist.

Beispiele für schlechte Variablen:

const date = new Date()
// Nome da varável é muito genêrica e n?o explica o que ela é

function getData(req, res) {}
// Nao descreve bem o dado que ela está requisitando 

Beispiele für gute Variablen:

const currentDate = new Date()
// Nome mais explicativo sobre o que ela é e menos genêrico

function getUserGithubCategory(req, res) {} 
// Descreve melhor o dado que a fun??o está requisitando 

Immer noch in derselben Logik des Schreibens aussagekr?ftiger Variablennamen kommen wir zu einem weiteren wichtigen Punkt, n?mlich beim Schreiben boolescher Variablen, die derselben Schreibrichtung folgen, aber wir müssen eine weitere kleine Regel verwenden, die sich an die vorherige anschlie?t.

Sie sagt Folgendes: Wir sollten boolesche Variablen so schreiben, als w?ren sie eine Art Frage, die mit Ja oder Nein beantwortet werden kann. Dies liegt daran, dass boolesche Variablen nur wahr (ja) oder falsch (nein) und eine Frage erhalten k?nnen Zu sagen, ob sie aktiv sind oder nicht, hilft beim Lesen des Codes.

Beispiel ohne Anwendung der Regel:

const ticketPark = user.ticketPark 

if (!ticketPark ) {
  throw new Error('O Marcos n?o possui um bilhete para entrar no parque!')
}

Beispiel mit Anwendung der Regel:

const hasUserTicket = user.hasTicket // o usuário tem o ticket ?

if (!hasUserTicket) { // se o usuário n?o tiver o ticket 
  throw new Error('O Marcos n?o possui um bilhete para entrar no parque!')
}

Stimmen Sie mir zu, dass die Verwendung dieses Modells zur Benennung boolescher Variablen das Lesen nicht einfacher macht, indem gesagt wird, dass der Benutzer, wenn er das Ticket hat, zu der Fahrt gehen kann, anstatt nur zu überprüfen, ob das Parkticket nicht vorhanden ist? gef?lscht? Die Verwendung dieser Art kann das Verst?ndnis Ihres Codes durch Dritte erheblich verbessern und Ihnen auch dabei helfen, Unklarheiten zu vermeiden.

Zuletzt haben wir noch eine weitere einfache Regel, die diese letzten beiden begleitet und die nicht nur dazu dient, Ihren Code besser zu schreiben, sondern auch darin besteht, Variablen zu verwenden, um die ?magischen Zahlen“ in Ihrem Code zu speichern. Aber was sind denn diese magischen Zahlen in Ihrem Code? Im Allgemeinen verwenden viele Programmierer bei der Anwendung von Gesch?ftsregeln auf ihre Projekte verschiedene Zahlen, um einige Vorg?nge im Code auszuführen, die wiederum in den Code eingefügt werden, ohne unbedingt eine Erkl?rung dafür zu haben, warum sie dort sind.

Beispiel für einen Code voller magischer Zahlen:

const date = new Date()
// Nome da varável é muito genêrica e n?o explica o que ela é

K?nnen Sie verstehen, wozu der Code dient?

Es ist schwierig mit diesen unbeschreiblichen Zahlen, oder?

Haben Sie jemals diesen Satz geh?rt: ?Ich wei? nicht, warum sonst der Code kaputt geht, wenn Sie ihn entfernen“? Es stellt gut dar, was ich hier sagen m?chte: Vermeiden Sie es, diese Zahlen lose zu lassen und ohne eine Erkl?rung, warum sie vorhanden sind. Wenn es nicht m?glich ist, sie in einer Variablen klarzustellen, k?nnen Sie in Ihrem Code einen einfachen Kommentar einfügen.

Schauen Sie sich an, wie dieser Code geschrieben werden sollte:

function getData(req, res) {}
// Nao descreve bem o dado que ela está requisitando 

Es ist jetzt besser, oder?

Vorteile

Die Einführung von Praktiken wie der klaren Benennung von Variablen, der Vermeidung magischer Zahlen und der Befolgung von Clean-Code-Prinzipien verbessert nicht nur die Qualit?t Ihres Codes, sondern erleichtert auch die Zusammenarbeit mit anderen Entwicklern und die langfristige Wartung.

Denken Sie daran: Beim Schreiben von sauberem Code geht es nicht darum, Perfektion zu erreichen, sondern darum, den Code für jeden, der ihn verwendet, zug?nglicher, verst?ndlicher und vorhersehbarer zu machen, auch für Sie in der Zukunft.

Versuchen Sie, diese Regeln auf Ihr n?chstes Projekt anzuwenden und bemerken Sie den Unterschied! Teilen Sie diese Tipps mit Kollegen oder Ihrem Team, um eine produktivere und effizientere Arbeitsumgebung zu schaffen. Schlie?lich ist gut geschriebener Code der erste Schritt zur Entwicklung hochwertiger Software.

Also, wie w?re es, wenn wir heute anfangen würden? Schreiben Sie Code, den Sie in Zukunft gerne lesen werden!

Das obige ist der detaillierte Inhalt vonVariablenbenennung basierend auf sauberem Code. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!