Zoeken…
Definieer de codestijl voor een project
PhpStorm biedt standaardinstellingen voor codestijl voor een groot aantal talen op basis van best practices en gemeenschappelijke normen. Maar je kunt de styling aanpassen voor elke taal op een per-project basis binnen de PhpStorm Instellingen> Editor> Code Style.
regelingen
Schema's zijn verzamelingen richtlijnen en instellingen voor codestijl. U kunt een schema voor een project selecteren en het wordt onmiddellijk toegepast. Er is ook een projectschema dat alleen beschikbaar is terwijl u een project open heeft. Het projectschema slaat de richtlijnen niet op in algemene gebruikersinstellingen, maar in de eigen instellingen van het project.
Als u op de knop Beheren klikt, kunt u een nieuw schema toevoegen om snel een nieuwe set richtlijnen voor codestijlen op te stellen. Het vak Beheren kan ook worden gebruikt om schema's te exporteren of importeren, wat erg handig is als u schema's met uw vrienden of collega's wilt delen.
Wijzig de stijl voor een specifieke taal
Om de codestijlinstellingen voor een specifieke taal te wijzigen, klikt u eenvoudig op de beschikbare taal in de zijbalk. U krijgt dan een instellingenpagina te zien die voor elke taal anders is.
De PHP-taal heeft bijvoorbeeld instellingen voor tabbladen en spaties, accolades of PHP-documenten.
Als je wilt weten wat elke verschillende instelling betekent, kun je ze opzoeken in de officiële documentatie.
Codestijldocumentatie voor PhpStorm 2016 en hoger
Een specifieke codestijl afdwingen voor een project voor meerdere teamleden
Momenteel is er geen methode met één klik om daadwerkelijk codestijlrichtlijnen binnen een team af te dwingen, maar er zijn twee methoden om ervoor te zorgen dat een bepaalde codestijl op uw product wordt toegepast.
Importeer PhpStorm Code Style Schemes
De eerste en gemakkelijkere oplossing is om een code-stijlschema op uw eigen PhpStorm-instantie in te stellen, het schema naar een draagbare schijf of netwerkschijf te exporteren en het schema op alle ontwikkelingsmachines te importeren.
Op deze manier kan een ontwikkelaar eenvoudig de sneltoetsen Cmd + Shift + L (MacOS) of Ctl + Alt + L (Windows / Linux) gebruiken om de volledige broncode automatisch te formatteren.
U kunt hierover meer informatie vinden in de volgende documentatie:
De broncode opnieuw formatteren in PhpStorm 2016 en hoger
Cons
Helaas is er geen manier om te controleren of een ontwikkelaar de code opnieuw heeft ingevoerd. Je zou moeten vertrouwen op de beloften van de ontwikkelaars dat ze voor de herformattering zorgen.
Geautomatiseerde code-indeling controleert met een CI-server
Een zeer strikte manier om de opmaak van broncodes te beheren, is door een continuos-integratieserver zoals Jenkins te implementeren die kan controleren of de broncode overeenkomt met een vooraf gedefinieerde codestijl.
Laten we aannemen dat een ontwikkelaar aan een nieuwe functie op zijn eigen ontwikkelingstak heeft gewerkt en zijn wijzigingen naar de hoofdrepository wil pushen. Eerst duwt hij de wijzigingen naar zijn eigen branch waar de nieuwe functie door de CI-server wordt gecontroleerd. Als de controle is mislukt omdat de code niet correct is opgemaakt, ontvangt de ontwikkelaar een melding zodat hij de problemen kan verhelpen.
Er zijn verschillende manieren om codekwaliteit en opmaakcontroles met alle verschillende integratieservers in te stellen, dus u moet uitleggen hoe u een server met controles instelt in de bijbehorende tags.
Stel codestijlen in van een vooraf gedefinieerde standaard zoals PSR-2
PhpStorm wordt al geleverd met veel vooraf gedefinieerde taalschema's die zijn gebaseerd op gemeenschappelijke codestijlrichtlijnen en standaarden zoals PSR-2 . Er is een soort verborgen functie op de instellingenpagina's van de codestijl waar u deze normen kunt importeren en instellen als uw huidige configuratie. Kies hiervoor eenvoudig uw coderingstaal in het linkerdeelvenster. Dan is er een kleine link rechtsboven genaamd Set from ...
Door op deze link te klikken, presenteert PhpStorm een kleine pop-up waarin u kunt kiezen uit de vooraf gedefinieerde standaarden op het tabblad Vooraf gedefinieerde stijl .
