11 stycznia 2019

Dobre praktyki programistyczne cz.1

Pisać każdy może, trochę lepiej, lub trochę gorzej.
Wielu programistów ubolewa nad tym, że php jest językiem programowania od którego wielu zaczyna, a skoro zaczynają, popełniają masę błędów i piszą swój kod niechlujnie.

Rozwiązaniem problemu może być podrzucenie im artykułów dotyczących dobrych praktyk. Lecz kto jest w stanie zapamiętać wszystkie reguły ? Tylko osoba z długim doświadczeniem, początkujący po przeczytaniu poradnika po prostu zapomną o regułach i będą cieszyć się, że ich kod działa.

Python ma jeden zasadniczy plus, wymusza na programiście stosowanie kilku reguł w sposób prawidłowy, inaczej zwróci nam error. Np. stosowanie tabulacji.

Przykład złego kodu:

W php kod może wyglądać tak:

<?php
class tojestmoja_pierwszaKlasa{
var $zmienna;
function Obliczto($p){
return $p+1;}
}
$ob = new tojestmoja_pierwszaKlasa();
echo $ob->Obliczto('12');

Wybaczcie to powyżej, nie będę liczył nawet ile złamanych zasad zostało na powyższym przykładzie. Opiszę za to w jaki sposób za nas, może to zrobić automat 🙂

Zacznijmy od jednego, jest to pierwszy wpis z serii „Dobre praktyki programistyczne”.

Porada 1.

Proszę zmień swój notepad++ na jakieś porządne IDE, do wyboru masz kilka darmowych programów, również są płatne.

Przykładem płatnego programu jest phpstorm.

Nie jestem zwolennikiem płacenia za program jeśli jesteśmy początkującymi programistami. PhpStorm nie sprawi że nagle przeskoczysz kilka poziomów wyżej i będziesz lepszy od ludzi którzy korzystają z darmowego NetBeans lub Visual Studio Code.

Dwa ostatnie programy są darmowe, zachęcam do sprawdzenia który jest dla nas bardziej przyjazny.

Porada 2.

Masz już zainstalowany jeden z powyższych programów. Podkreślanie błędów oraz uzupełnianie powoduje że popełniasz mniej błędów.

Zainstalujmy teraz plugin który będzie sprawdzał czy nasz kod jest zgodny z PSR.

Co to PSR ? Opiszemy w następnym wpisie, ale już teraz możemy sprawić, ze nasze IDE będzie wytykać nam nasze niedbalstwo 🙂

  1. Ściągamy PHP CodeSniffer lub używamy do tego narzędzia composer.
  2. W NetBeans
    1. Tool->Options->PHP->Code Analysis
    2. W Code Sniffer podajemy ścieżkę do pliku phpcs oraz wybieramy standard, ja wybrałem PSR-12
    3. Teraz aby sprawdzić nasz kod wybieramy: Source->Inspect
  3. W Visual Studio Code
    1. Extensions
    2. Wpisujemy phpcs i instalujemy, następnie resetujemy IDE
    3. Setting->Extensions->PHP CodeSniffer configuration
    4. Podajemy ścieżkę do pliku phpcs
    5. Standard->Edit in settings.json
    6. W prawym oknie wpisujemy „phpcs.standard”: „psr12”
    7. Aby zobaczyć listę błedów, wybieramy: View->Problems

Podsumowanie

Jest to bardzo prosty/szybki poradnik, oczywiście można kod sprawdzać pod kontem zgodności z PSR12 wydając polecenie w terminalu. Pewnie jakieś narzędzia online też się znajdą, jednak jest to w mojej ocenie niewygodne.

Kod który umieściłem powyżej według CodeSniffer ma 15 błędów.

Ogłoszeniem parafialnym jest jeszcze to, że wkrótce napiszę więcej wpisów związanych z przygotowaniem swojego IDE do wygodnej pracy, oraz o zasadach dobrego programowania.