Oczyść fragment kodu PHP

Dlaczego formatowanie pomaga czytelnikowi

Ludzie czytają kod po jego kształcie. Gdy nawiasy klamrowe są w jednej linii, a każda instrukcja ma własny wiersz, czytelnik widzi strukturę, zanim przeczyta choć jedno słowo. Recenzent może wtedy zauważyć brakujący nawias lub pętlę w złym miejscu. Płaski blok tekstu ukrywa wszystko to.

Przed i po

Oryginał, skopiowany z logu:

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

Oczyszczony z 4 spacjami:

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

Krótka lista kontrolna przed publikacją

• Usuń sekrety. Tekst wklejony tutaj jest przetwarzany na naszym serwerze, więc nie używaj prawdziwych danych logowania, tokenów ani danych klientów.
• Zachowaj przykład minimalny, z tylko tymi wierszami, które są potrzebne do pokazania problemu.
• Podaj, z jakiej wersji PHP korzystasz i czego się spodziewałeś.
• Porównaj sformatowany kod z oryginałem. Narzędzie zmienia tylko układ, ale na komentarze i łańcuchy znaków mogą wpływać reguły dotyczące białych znaków.
• Umieść wynik w bloku kodu, aby wcięcia zostały zachowane.

Czym to narzędzie nie jest

Nie znajduje błędów, nie uruchamia kodu i nie sprawdza reguł stylu. Przejrzysty układ ułatwia dostrzeżenie problemu, ale go nie rozwiązuje.

Gdzie to pomaga

• Zgłoszenie do wsparcia lub raport błędu zawierający przykład kodu.
• Pytanie na forum dla programistów lub w kanale czatu.
• Strona dokumentacji lub poradnika, na której przykład musi wyglądać schludnie.
• Komentarz w recenzji, w którym proponujesz zmianę fragmentu funkcji.

W każdym z tych przypadków czytelnik najpierw widzi strukturę, a dopiero potem problem, czyli w kolejności, jakiej chcesz.

Zachowaj przykład wiarygodny

Formatuj kod, który faktycznie zamierzasz opublikować, a nie jego czystszą wersję. Jeśli skracasz nazwy zmiennych lub usuwasz wiersze, aby przykład się zmieścił, najpierw uruchom samodzielnie skróconą wersję. Ładny fragment, który nie odtwarza problemu, marnuje czas czytelnika. Jeśli dodajesz uwagę o oczekiwanym wyniku, napisz ją zwykłymi słowami nad blokiem kodu.