Upiększacz kodu PHP

Co oznacza upiększanie

Upiększacz zmienia tylko układ. Kod powinien robić to samo przed i po przekształceniu. To narzędzie stosuje krótką listę reguł układu:

• Każdy średnik kończy wiersz.
• Każdy otwierający nawias klamrowy trafia do osobnego wiersza, podobnie jak każdy zamykający.
• Kod wewnątrz nawiasów klamrowych jest wcinany o jeden poziom na każdą głębokość zagnieżdżenia.
• Po przecinku następuje pojedyncza spacja.
• Puste wiersze w wyniku są usuwane.

Nie dodaje spacji wokół operatorów, nie zmienia nazw i nie przestawia kodu.

Przykład przed i po

Dane wejściowe:

<?php class User{private $name;public function getName(){return $this->name;}}

Wynik z 4 spacjami:

<?php class User
{
    private $name;
    public function getName()
    {
        return $this->name;
    }
}

Zwróć uwagę, że otwierający znacznik pozostaje w tym samym wierszu co pierwsza instrukcja, gdy wklejasz wszystko w jednym wierszu. Umieść znacznik w osobnym wierszu w danych wejściowych, jeśli chcesz, aby był oddzielny.

Kiedy lepiej użyć czegoś innego

Narzędzie traktuje nawiasy klamrowe i średniki jako zwykłe znaki. Nie analizuje PHP, więc nie zastosuje stylu projektu, nie zawinie długich wierszy ani nie poprawi spacji wokół operatorów takich jak = i +. Komentarze, heredoc i pętle for (;;) mogą wyjść źle, ponieważ średnik w nich jest traktowany jak każdy inny. Dla całej bazy kodu uruchom skonfigurowany formater w edytorze lub w potoku budowania, a tę stronę zostaw do szybkich jednorazowych porządków.

Upiększanie funkcji z pętlą

Zwarte dane wejściowe:

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

Każdy nawias klamrowy otwiera nowy poziom, więc ciało pętli znajduje się dwa poziomy głębiej, a return wraca na jeden poziom. Czytając od góry do dołu, widzisz teraz, że pętla dodaje do $sum, a funkcja zwraca tę wartość na końcu. W wersji jednowierszowej było to trudne do zauważenia.

Wybór 2 lub 4 spacji

Cztery spacje to powszechna szerokość w kodzie PHP i najłatwiejsza do przeskanowania. Wybierz 2, gdy kod jest głęboko zagnieżdżony lub miejsce, w które wklejasz, jest wąskie, na przykład wiadomość na czacie. To ustawienie zmienia tylko wcięcie, nigdy podziały wierszy.

Sprawdź wynik

Upiększony kod łatwiej się przegląda i o to właśnie chodzi. Przeczytaj go raz pod kątem brakujących lub nadmiarowych nawiasów klamrowych, ponieważ narzędzie je liczy bez zgłaszania problemów. Jeśli wcięcie dziwnie się rozjeżdża pod koniec, typową przyczyną jest niesparowany nawias w danych wejściowych.