WordPress kodning Standards Indentation, Space Usage och Trailing Spaces

Hela syftet med denna serie för att hjälpa till att avslöja WordPress-kodningsstandarderna, varför de spelar roll och hur man skriver kvalitets WordPress-kod. För att göra detta, tar vi en djupgående titt på varje avsnitt av WordPress-kodningsstandarderna.

Hittills har vi täckt:

  • Namngivna konventioner och funktionsargument
  • Enkla citat och dubbla citat

Idag kommer vi att täcka vikten av vitt utrymme. Specifikt kommer vi att täcka inryckning, utrymmeanvändning och efterföljande utrymmen. Så enkelt som det låter är det flera av de mest ignorerade eller missbrukade aspekterna av kodningsstandarderna.


Ett ord om whitespace

Innan vi tittar på vad som händer med de olika kodningsstandarderna är det viktigt att förstå varför det vita utrymmet är viktigt inte bara i WordPress, utan även i programmeringsspråk i allmänhet.

Enkelt uttryckt är det för att det förbättrar läsbarheten.

Det är därför vissa programmeringsspråk är avgränsade av utrymme eller flik, det är därför som vissa programmeringsspråk ber om att du delar ut vissa delar av koden, såsom funktionsparametrar, arrayindex och mer.

När det gäller WordPress finns konventionerna inte bara för läsbarhet utan också för att ge en konsekvent läsning och utvecklingsupplevelse för alla som arbetar med WordPress-teman, plugins, applikationer eller själva kärnansökan.

Kom ihåg: Syftet med kodningsstandarden är att göra det så att källkoden ser ut som om den är skriven av en enda utvecklare, eftersom den ställer en nivå av förväntningar för att bidra till utvecklare.


Indrag

Vad beträffar indragning finns det inget särskilt nytt, revolutionärt eller annorlunda när det gäller WordPress. I allmänhet anger du varje gång du startar ett nytt block.

Detta innebär att:

  • Dina funktioner kommer att vara indragna i klassen
  • Dina villkor och växlar / fall och andra block kommer att vara indragna inom sina funktioner
  • Din slingor kommer att vara indragna inom sina funktioner, inom deras villkor, och så vidare

Om du är van att skriva kod i C-stil språk, så är det inget särskilt nytt här, rätt?

Ett exempel på hur detta kan se ut är just detta:

 funktion foo ($ arguments) if (0 < count( $arguments )  foreach ( $arguments as $arg => $ värde) echo $ value; 

Enligt kodningsstandarderna:

Din indragning bör alltid återspegla den logiska strukturen. Använda sig av riktiga flikar och inte mellanslag, eftersom detta möjliggör mest flexibilitet över kunderna.

Det viktigaste sättet är att början av raderna bör börja med flikar och att koden ska spegla a logisk strukturera. Överkomplicera inte eller försök att förenkla saker.

Det finns en ny nyans till det vita utrymmet i WordPress-kodningsstandarderna: Flikar ska användas i början av raden, men mellanslag ska användas överallt. För det mesta är detta en enkel regel att följa; Men i WordPress kommer du ofta att skapa arrayer för att passera som argument.

Helst vill vi att varje index i arrayen stämmer så att läsbarheten är så hög som möjligt, men vi brukar ha en benägenhet att använda flikar för att göra det enklare att ordna dem, men det här är faktiskt en kränkning av kodningsstandarderna.

 $ args = array ('ID' => 1, 'post_title' => 'Titeln', 'post_content' => 'Innehållet');

Som sådan, se till att du endast använd flikar i början av varje rad.


Användning av rymden

När det gäller WordPress har jag funnit att mellanslag har använts mycket mer liberalt än på andra språk. Jag säger inte detta helt enkelt som en observation, eftersom det var en personlig anpassning som jag behövde göra i att komma både från .NET och Ruby.

Som sagt, som med de flesta andra riktlinjer i Codex finns det inget som är särskilt komplext. Det finns dock några viktiga skillnader som måste komma ihåg när man skriver kod.

Rum bör placeras på följande platser:

  • Efter kommatecken
  • På båda sidor av logiska operatörer (det vill säga, ||, &&, och !)
  • På båda sidor av jämförelseoperatörer (det vill säga, <, >, ==, ===, etc.)
  • På båda sidor av uppdragsoperatörer (nämligen =)
  • På båda sidor om öppning och stängning parentes av funktioner, conditionals, loopar och så vidare.
  • När en variabel överförs som ett index för en array, men inte när ett bokstavligt värde (som en sträng eller ett heltal)

De flesta av dessa är relativt raka framåt, men enligt min erfarenhet har jag funnit att arrayreglerna tenderar att skapa störst förvirring bland utvecklare, så här är en snabb notering av vad som anses vara korrekt och vad som inte är:

 // Korrekt avstånd ... $ arr [$ x] = 'foo'; $ arr [0] = 'bar'; // Felaktig avstånd ... $ arr [$ x] = 'bar'; $ arr [0] = 'bar';

Som du kan se är det inget hemskt komplicerat men det är en relativt lätt konvention att missa.


Trailing Spaces

Denna regel är troligtvis den enklaste standarden att komma ihåg av alla. Enkelt uttryckt, det borde inte finnas några efterföljande utrymmen kvar i slutet av någon kodlinje.

Beroende på ditt IDE kan du ha det här filtret inbyggt; andra gånger kan det hända att du måste installera ett plugin som utför denna åtgärd när du sparar filen. Men vad som helst, det är en relativt lätt funktion att integrera i vad som helst IDE du använder.

Dessutom, de flesta redaktörer - oavsett om det är en förhärligad textredigerare eller en full på IDE - bör du ha möjlighet att aktivera visning av flikar och mellanslag.

Visa flikar och whitespace i Coda 2

Återigen är detta en av de enklaste konventionerna att följa och det är troligt att din IDE eller redigerare har valfri funktion eller ett plugin som gör att du automatiskt kan göra det här.

Om inte, bör du kunna aktivera möjligheten att se flikar, mellanslag, vagnreturer och så vidare så att du enkelt kan identifiera var de bakre utrymmena är.


Slutsats

Vitt utrymme placerar självklart en viktig roll i WordPress-baserad kod. I den här artikeln har vi utforskat indryckning, flikar, mellanslag, efterföljande utrymmen och varför och hur man införlivar dem i våra projekt.

I nästa artikel kommer vi att fortsätta prata om subtiliteten i WordPress-kodningsstandarderna genom att titta på brace-stil, vanliga uttryck och nyanser av att använda PHP-taggar genom vår WordPress-kod.