Rensa upp ett PHP-kodexempel

Varför formatering hjälper läsaren

Människor läser kod utifrån dess form. När klammerparenteserna står på samma linje och varje sats har en egen rad ser läsaren strukturen innan hen läser ett enda ord. En granskare kan då upptäcka en saknad klammer eller en loop på fel ställe. Ett platt textblock döljer allt detta.

Före och efter

Ursprunglig kod, kopierad från en logg:

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

Rensad med 4 mellanslag:

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

En kort checklista innan du publicerar

• Ta bort hemligheter. Texten du klistrar in här bearbetas på vår server, så använd inga riktiga inloggningsuppgifter, token eller kunddata.
• Håll exemplet minimalt, med bara de rader som behövs för att visa problemet.
• Ange vilken PHP-version du använder och vad du väntade dig skulle hända.
• Jämför den formaterade koden med originalet. Verktyget ändrar bara layouten, men kommentarer och strängar kan påverkas av reglerna för blanksteg.
• Lägg resultatet i ett kodblock så att indragen bevaras.

Vad verktyget inte är

Det hittar inga fel, kör inte din kod och kontrollerar inte stilregler. En tydlig layout gör ett problem lättare att se, men den löser det inte.

Var detta hjälper

• Ett supportärende eller en felrapport som innehåller ett kodexempel.
• En fråga på ett utvecklarforum eller i en chattkanal.
• En dokumentationssida eller handledning där ett exempel behöver se prydligt ut.
• En granskningskommentar där du föreslår en ändring i en del av en funktion.

I varje fall ser läsaren strukturen först och problemet sedan, vilket är den ordning du vill ha.

Håll kodexemplet ärligt

Formatera koden du faktiskt ska publicera, inte en snyggare omskrivning av den. Om du förkortar variabelnamn eller tar bort rader för att exemplet ska få plats, kör den förkortade versionen själv först. Ett snyggt kodexempel som inte reproducerar problemet slösar läsarens tid. Om du lägger till en notering om vilket resultat du väntar dig, skriv den med vanliga ord ovanför kodblocket.