Wie schreibe ich lesbaren Code in PHP?

Erfolgreiche Entwicklungsteams verlangen von jedem Teammitglied, dass sie sich an die Regeln zur Wiederverwendung von Code halten. Diese Regeln treiben die Wiederverwendbarkeit von Code auf die Spitze, ohne die Kreativität und Entwicklungseffizienz der Entwickler wesentlich zu beeinträchtigen. Wenn die Entwickler, die den Code schreiben und verwenden, die allgemeinen Code- und Code-Kommentar--Anforderungen für Programmnamenskonventionen einhalten, wird die Wiederverwendbarkeit des Codes erheblich verbessert. Der Ausgangspunkt für diese Standards liegt auf der Ebene der Systemarchitektur. Ihre funktionale Spezifikation sollte diese Standards in der Definition von Klassen, Attributen Namen, Funktionsrückgabewerten und anderen wichtigen Programmelementen widerspiegeln. In diesem Artikel werden einige praktische Vorschläge zu grundlegenden Benennungsregeln und Kommentaren bereitgestellt, um den Lesern dabei zu helfen, ihre eigenen Standards für die Wiederverwendung von Code zu entwickeln.

Groß-/Kleinschreibung

Bevor wir mit der Erörterung der korrekten Benennung verschiedener Programmelemente beginnen, definieren wir die beiden gebräuchlichsten Methoden zur Unterscheidung der Groß-/Kleinschreibung von Elementen. Sie sind:

Pascal-Spezifikation – Das erste Zeichen wird großgeschrieben, und der erste Buchstabe jedes Wortes im Zielnamen wird ebenfalls großgeschrieben, z. B. InvoiceNumber oder PrintInvoice. Alle anderen Zeichen sind Kleinbuchstaben.
Camel-Spezifikation – das erste Zeichen wird nicht großgeschrieben, aber der erste Buchstabe jedes Wortes im Zielnamen wird großgeschrieben, zum Beispiel „invoiceNumber“. Alle anderen Zeichen sind Kleinbuchstaben.
Allerdings kann die Verwendung von Elementen, bei denen die Groß-/Kleinschreibung beachtet wird, in Programmiersprachen, bei denen die Groß-/Kleinschreibung nicht beachtet wird, zu Problemen führen. Da in der C#-Sprache beispielsweise die Groß-/Kleinschreibung beachtet wird, können Sie die private Variable „mitarbeiter“ aufrufen und dann deren öffentliche Eigenschaft „Mitarbeiter“ vom Aufrufer verwenden. Diese Operationen sind völlig legal. Bei Visual Basic tritt jedoch ein Fehler auf, da VB die Groß-/Kleinschreibung nicht berücksichtigt und die beiden oben genannten Elemente in den Augen von VB dasselbe sind. Wenn Sie in einer Umgebung mit gemischten Sprachen arbeiten, können Sie nur bestimmte Regeln festlegen, die von Entwicklern verlangen, dass sie sinnvollerweise mehrere Sprachen verwenden, um von anderen entwickelten Code zu lesen.


Benennungsstandards
Angenommen, wir übernehmen die oben genannten Fallstandards, schauen wir uns nun einige einfache Benennungsvorschläge für gängige Programmelemente an.

Klassen
Einige Klassen sind so konzipiert, dass sie reale Objekte simulieren. Für diese Klassen sollten die gewählten Namen die realen Objekte widerspiegeln, mit Singular-Substantiven, wie „Mitarbeiter“, „Rechnung“ oder „Zeitkarte“ usw. Für innere Klassen kann die Pascal-Spezifikation verwendet werden, um der Ergebnisklasse einen eindeutigen Namen zu geben, z. B. ThreadPool oder CustomColor usw. Klassen sollten im Singular stehen, damit ihre Pluralform ähnliche Sammlungsnamen wie das Employees-Array usw. darstellen kann.

Mitglieder einer Klasse
Entwickler, die C# und andere Programmiersprachen verwenden, bei denen die Groß-/Kleinschreibung beachtet wird, sollten für die Benennung von Klassenmitgliedern die Camel-Konvention verwenden. Dies erleichtert Entwicklern die Unterscheidung zwischen den Namen interner Variablen und den Namen öffentlicher Eigenschaften. Viele VB-Entwickler verwenden zur Benennung von Klassenmitgliedern lieber die ungarische Nomenklatur, d . Ich halte es für unnötig, dies in einer fortgeschrittenen Entwicklungsumgebung wie VS.NET zu tun, da in diesem Fall der Variablentyp des Systems automatisch angezeigt werden kann, wenn die Systemmaus auf der Variablen bleibt. Ich persönlich stelle den Namen von Klassenmitgliedern gerne den Kleinbuchstaben m voran. Auf diese Weise speichert die interne Variable genügend interne Klasseninformationen: Die interne Variable mName repräsentiert lediglich das öffentliche Attribut Name. Methoden
Methoden sollten gemäß der Pascal-Spezifikation benannt werden und ihr Implementierungsverhalten sinnvoll beschreiben. Beispielsweise kann die Methode zum Hinzufügen von Mitarbeitern zur Datenbank „AddEmployee“ und die Methode zum Drucken von Rechnungen „PrintInvoice“ heißen. Wenn die Methode einen booleschen Wert zurückgibt, sollte der Methodenname mit einem Verb beginnen, damit seine Bedeutung bei Verwendung in einer if-Anweisung klarer wird. Wenn Sie beispielsweise über eine Methode verfügen, die bestimmt, ob ein Mitarbeiter die Anforderungen des 401k-Plans des Unternehmens erfüllt, können Sie die IsEligible401k-Methode in einer If-Anweisung aufrufen: If IsEligible401k then...

Methodenparameter, Rückgabewert , und Variablen
Alle Methodenparameter, Rückgabewerte und Variablen sollten gemäß den Pascal-Spezifikationen benannt werden, sie sollten auch die Bedeutung der Parameter oder Variablen widerspiegeln. Dies ist besonders wichtig für Parametermethoden, da Intellisense beim Aufruf der Methode den Parameternamen und den Parametertyp zurückgibt. Alle Entwickler, die Methoden verwenden, sollten beschreibende Namen und Typen verwenden, damit ihre Bedeutung für beide Seiten verständlich ist.

Steuerelemente
Die Benennung von Steuerelementen ist in der Entwicklungswelt ein häufig kontroverses Thema. Obwohl sich die meisten Menschen darin einig sind, dass die Standardnamen von Steuerelementen wie TextBox1 oder Label1 usw. nicht verwendet werden sollten, lehnen sie es auch ab, Steuerelemente als Variablen zu benennen oder Präfixe zu verwenden, um den Steuerelementtyp anzugeben. Ich bevorzuge die Verwendung des Standardpräfixes mit drei Buchstaben für die Benennung von Steuerelementen in einem Formular. Beispielsweise können die Textfeldsteuerelemente, die den Vor- und Nachnamen speichern, jeweils den Namen txtLastName und txtFirstName tragen. Die Befehlsschaltfläche, die Formulardaten verarbeitet, kann cmdSubmit oder cmdCancel heißen. Solange Sie sicherstellen können, dass die Benennung der Steuerelemente konsistent ist und der Standard leicht verständlich ist.

Kommentare
Das Kommentieren von Code ist für alle Entwickler erforderlich. Um die richtigen Annotationstechniken zu vermitteln, füge ich meinen Demoprogrammen häufig annotierten Code hinzu. Um den Annotationsprozess zu vereinfachen, empfehle ich außerdem, dass Entwickler zunächst Kommentare schreiben, die das Programm beschreiben, das sie schreiben möchten. Ich werde zunächst Kommentare schreiben, um die Prozeduren, Klassen oder andere Programmelemente im Programm zu beschreiben, aber nicht erklären, wie sie funktionieren. Dann würde ich eine Reihe kommentierten Codes schreiben, der jeden wichtigen Schritt des Prozesses oder jedes Element der Klasse beschreibt. Nachdem ich den Code geschrieben habe, der die Klasse definiert oder den Prozess beschreibt, dokumentiere ich jede externe Variable, jedes Steuerelement, jede geöffnete Datei und sogar alle Elemente, auf die andere Prozesse zugreifen, und erkläre kurz die Eingabeparameter und Rückgabewerte.

Wenn Sie ein Programm in C# entwickeln, verfügt die VS.NET-Umgebung bereits über integrierte Tools, die Ihnen beim Konvertieren interner C#-Kommentare in externe HTML-Dokumente helfen. Sie können Ihrem eigenen Dokument spezielle Verarbeitungsanweisungen hinzufügen, um die Darstellung des externen Dokuments zu ändern. Weitere Informationen hierzu finden Sie in der internen VS.NET-Hilfedatei: ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcoriXMLDocumentation.htm

Das obige ist der detaillierte Inhalt vonWie schreibe ich lesbaren Code in PHP?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!