Szukaj…


Zdefiniuj styl kodu dla projektu

PhpStorm oferuje domyślne ustawienia stylizacji kodu dla dużej liczby języków w oparciu o najlepsze praktyki i wspólne standardy. Ale możesz dostosować styl dla każdego języka w bazie dla jednego projektu w Ustawieniach PhpStorm> Edytor > Styl kodu .

Ustawienia stylu kodu

Schematy

Schematy to zbiory wytycznych i ustawień stylu kodu. Możesz wybrać schemat projektu, który zostanie natychmiast zastosowany. Istnieje również schemat projektu, który jest dostępny tylko wtedy, gdy masz otwarty projekt. Schemat projektu nie zapisuje wytycznych w ogólnych ustawieniach użytkownika, ale we własnych ustawieniach projektu.

Po kliknięciu przycisku Zarządzaj możesz dodać nowy schemat, aby szybko skonfigurować nowy zestaw wytycznych dotyczących stylu kodu. Za pomocą okna Zarządzaj można również eksportować lub importować schematy, co jest bardzo przydatne, jeśli chcesz udostępnić schematy znajomym lub współpracownikom.

Pole zarządzania stylem kodu

Zmień styl dla określonego języka

Aby zmienić ustawienia stylu kodu dla określonego języka, po prostu kliknij dostępny język na pasku bocznym. Zostanie wyświetlona strona ustawień inna dla każdego języka.

Na przykład język PHP będzie miał ustawienia dla tabulatorów i spacji, nawiasów klamrowych lub Dokumentów PHP.

Styl kodu dla PHP

Jeśli chcesz wiedzieć, co oznaczają poszczególne ustawienia, możesz je sprawdzić w oficjalnej dokumentacji.

Dokumentacja stylu kodu dla PhpStorm 2016 i nowszych wersji

Wymuszaj określony styl kodu dla projektu w wielu członkach zespołu

Obecnie nie ma metody umożliwiającej wymuszenie wytycznych dotyczących stylu kodu w zespole za pomocą jednego przycisku, ale istnieją dwie metody upewnienia się, że określony styl kodu jest zastosowany do produktu.

Importuj schematy stylu kodu PhpStorm

Pierwszym i łatwiejszym rozwiązaniem jest skonfigurowanie schematu stylu kodu we własnej instancji PhpStorm, eksportowanie schematu na dysk przenośny lub dysk sieciowy i importowanie schematu na wszystkich komputerach programistycznych.
W ten sposób programista może łatwo użyć skrótów klawiaturowych Cmd + Shift + L (MacOS) lub Ctl + Alt + L (Windows / Linux), aby automatycznie sformatować pełny kod źródłowy.

Bardziej szczegółowe informacje na ten temat można znaleźć w następującej dokumentacji:

Ponowne formatowanie kodu źródłowego w PhpStorm 2016 i nowszych wersjach

Cons
Niestety nie ma sposobu, aby sprawdzić, czy programista naprawdę zastosował formatowanie kodu. Będziesz musiał polegać na obietnicach deweloperów, że zajmą się przeformatowaniem.

Zautomatyzowane kontrole formatu kodu za pomocą serwera CI

Bardzo ścisłym sposobem kontrolowania formatowania kodu źródłowego jest zaimplementowanie serwera integracji Continuos, takiego jak Jenkins, który jest w stanie sprawdzić, czy kod źródłowy jest zgodny ze zdefiniowanym stylem kodu.

Załóżmy, że programista pracował nad nową funkcją we własnej gałęzi programistycznej i chce przekazać swoje zmiany do głównego repozytorium. Najpierw przekazuje zmiany do swojego oddziału, gdzie nowa funkcja zostanie sprawdzona przez serwer CI. Jeśli sprawdzenie się nie powiedzie, ponieważ kod nie jest poprawnie sformatowany, programista zostanie o tym powiadomiony, dzięki czemu będzie mógł rozwiązać problemy.

Istnieją różne sposoby konfiguracji jakości kodu i kontroli formatowania dla wszystkich różnych serwerów integracyjnych, dlatego wyjaśnienie, jak skonfigurować serwer z kontrolami, powinno odbywać się w odpowiednich znacznikach.

Ustaw style kodu ze wstępnie zdefiniowanego standardu, takiego jak PSR-2

PhpStorm zawiera już wiele predefiniowanych schematów językowych opartych na wspólnych wytycznych i standardach stylu kodu, takich jak PSR-2 . Na stronach ustawień stylu kodu istnieje ukryta funkcja, za pomocą której można zaimportować te standardy i ustawić je jako bieżącą konfigurację. Aby to zrobić, po prostu wybierz język kodowania w lewym panelu. Następnie w prawym górnym rogu znajduje się mały link o nazwie Ustaw z ...

Klikając ten link, PhpStorm wyświetli małe okienko, w którym możesz wybrać spośród predefiniowanych standardów w zakładce Styl predefiniowany .

Zestaw stylów phpStorm z



Modified text is an extract of the original Stack Overflow Documentation
Licencjonowany na podstawie CC BY-SA 3.0
Nie związany z Stack Overflow