Dlaczego potrzebujesz kodu Sniffer do tworzenia stron internetowych

Optymalizacja kodu jest porównywalna z fazą edycji pisma. Możesz najpierw potrzebować swoich pomysłów w kodzie, ale twój kod powinien być zoptymalizowany za pomocą takich narzędzi jak sniffery kodu wyprodukować najlepszy możliwy produkt.

Wąchanie kodu to termin, który opisuje sprawdzanie kodu pod kątem zgodności ze standardami regulacyjnymi. Te przepisy mogą określać liczbę spacji, które mają być używane do wcięć, rozmieszczenie nawiasów klamrowych lub jak nazywać zmienne. Standardy nie są niezbędne do zbudowania aplikacji internetowej, ale ważne są standardy dla wewnętrznej spójności i utrzymania kodu.

To jest, gdzie wąchanie kodu przydaje się wszystkim programistom, frontend do backend. Chciałbym zbadaj proces wąchania kodu i oferuję trochę narzędzia, które pomagają analizować standardy kodu.

Co to jest wąchanie kodu?

Działanie wąchania kodu jest zazwyczaj zautomatyzowane oszczędzaj czas i zmniejsz błędy. Będą sniffery kodu sprawdź kody źródłowe pod kątem zgodności ze standardami ustalone przez wewnętrzne zespoły ds. rozwoju lub organy regulacyjne.

Wąchanie kodu jest podobne do szarpania kodu, ale bardziej pedantyczne. Linting głównie sprawdza błędy i błędy składniowe podczas wąchania szuka problemów w sposób pisania kodu. Plik PHP może nadal działać poprawnie, ale nie powiedzie się testowi sniffingu kodu, jeśli nazwa zmiennej nie spełnia standardów (np. $ myVariable vs $ my_variable).

Podobny fragment terminologii to zapach kodu, który sprawdza błędy projektowe w kodzie, który może prowadzić do większych błędów. Może to dotyczyć norm kodowych, ale obejmuje również architektury wyższego poziomu do pisania jednorodnego kodu.

Wszystkie te obszary są warte omówienia i są odpowiednie do wąchania kodu. Pamiętaj tylko, że kod do wąchania nie zawsze znajdzie błędy runtime ponieważ jego priorytetem jest utrzymywanie ścisłej zgodności ze standardami.

Do tej pory możesz zadawać sobie pytanie, czy standardy mają znaczenie? Prawda jest taka, że mają znaczenie, ale bardziej dla optymalizacji i porządkowania projektów. Wielu programistów zgadza się, że standardy mają kluczowe znaczenie dla programowania i tworzenia stron internetowych - zwłaszcza w przypadku dużych zespołów.

Oto cytat od twórcy Paula Jonesa wyjaśniający, dlaczego standardy kodowe są przydatne.

“Celem standardu stylu kodowania nie jest twierdzenie, że jeden styl jest obiektywnie lepszy niż inny… Zamiast tego chodzi o ustalenie znanych oczekiwań dotyczących sposobu, w jaki kod będzie wyglądał.”

Jeśli budujesz dla siebie małą aplikację internetową, może nie warto spędzać czasu na standardach WCAG 2.0 lub PSR-2. Ale zastanów się nad setkami programistów pracujących nad kodem źródłowym Adobe Photoshop. Byłoby chaotycznie, gdyby każdy napisał swój własny styl i połączył to wszystko razem.

Chociaż zespoły w dużym stopniu opierają się na standardach, zasady te mogą być przydatne także dla samotnych programistów. Możesz znaleźć standardy kodu dla wszystkiego, od CSS do WordPress, więc nie ma usprawiedliwienia, aby nie próbować sprawdzić, czy jakość twojego kodu poprawia się.

Wartość standardów kodeksu

Standardy będą naturalnie utrzymuj swój kod w czystości i zorganizowany. Deweloperzy wiedzą dokładnie, jak pisać kod i jak postępować zgodnie ze swoją pracą.

Standardy kodu pomagają także w rozwoju otwartego oprogramowania, oferując reguły, których mogą przestrzegać inni. Pliki mogą być odebrane przez każdego miesiąc lub lata później i nadal są łatwe do odczytania.

Dokładny styl kodowania to dobry pomysł nawet jeśli zdecydujesz się na swój własny. To wymaga dużo wysiłku, ale w miarę rozwoju projektów tego typu dokumentacja jest nieoceniona.

Oto niektóre standardy kodowania, które uwzględniają gamę różnych języków internetowych.

Standardy kodowania PEAR (PHP)
Standardy Google dla HTML / CSS
Standardy Google dla JavaScript
Styl kodowania Django (Python)
Przewodnik po stylach Rails (Ruby)
WCAG 2.0 (UX)

Najlepsze zasoby do wykrywania kodu

Teraz można znaleźć bezpłatne sniffery kodu do wszystkiego, od HTML / CSS do języków zaplecza, takich jak PHP i SQL. Nie musisz używać tych snifferów ani stosować się do standardów dla każdego języka, ale warto zbadać możliwości sprawdzenia, co może poprawić Twoją wydajność.

Sniffery kodu frontendowego

Chociaż HTML nie potrzeba sniffer kodu, który nie powstrzymał Squiza przed zbudowaniem jednego. Jest to całkowicie otwarte źródło i hostowane na GitHub z opcjami kopiowania / wklejania kodu do przeglądarki lub zapisywania bookmarkletu do uruchamiania na poszczególnych stronach internetowych.

Ten sniffer sprawdza zgodność z trzema poziomami standardów dostępności A, AA i AAA WCAG wraz z wytycznymi sekcji 508, które dotyczą przede wszystkim witryn rządowych.

Deweloperzy CSS mogą polubić ten darmowy sniffer kodu CSS, który jest również open source, obsługiwany przez Menedżera pakietów Node.

Użytkownicy jQuery powinni sprawdzić JSCodeSniffer zbudowany przez Dmitry'ego Sheiko. Jest to kolejny darmowy webapp obsługiwany przez GitHub, który jest zgodny z przewodnikiem stylu kodu jQuery.

Alternatywnie możesz wypróbować kodowanie kodu JS za pomocą JavaScript Lint lub JS Lint. Narzędzia te sprawdzają błędy w składni, a nie w kodach, ale są również bardzo pomocne w optymalizacji kodu frontendowego.

Dla przypomnienia, możliwe jest również sprawdzenie standardów JS / CSS bezpośrednio z PHP_CodeSniffer.

Sniffer kodu PHP

PHP_CodeSniffer jest niezbędnym narzędziem w pasku narzędzi, jeśli szukasz zgodności ze standardami kodu PHP. Pakiet zawiera kilka Skrypty PHP analizujące kod PHP, JS i CSS pod kątem zgodności z wyborem dokumentacji stylu kodu.

Twórca PHP_CodeSniffer Greg Sherwood napisał wspaniałą historię o tym, jak powstał pomysł i jakie problemy próbuje rozwiązać (warto przeczytać, jeśli masz czas).

Podsumowując, Greg pracował z zespołem uczącym się JavaScript wbudowanym w aplikację PHP. Ich celem było ustrukturyzowanie JS w sposób zgodny ze standardami kodu PHP, aby ułatwić życie przełączając się tam iz powrotem. W ten sposób narodził się PHP_CodeSniffer.

To jest świetne dla programistów PHP, ponieważ język jest bardzo luźny z obowiązkowymi wymaganiami stylu. Ramy takie jak Laravel są bardziej rygorystyczne, ale programiści mogą (i powinni) ustawić własne standardy kodu bez polegania na platformie innej firmy.

Różne standardy, takie jak PSR-0, PSR-1 i PSR-2, są popularne i pakowane w bibliotece sniffingu PHP.

Ale możesz znaleźć wiele innych gotowych standardów kodu dla PHP CMS, takich jak WordPress, Magento i Drupal. Programiści na rdzeniu Drupala wydali nawet oficjalny moduł sniffera kodu o nazwie Coder.

PHP jest niewątpliwie najłatwiejszym językiem do optymalizacji za pomocą snifferów kodu. Jeśli szukasz lista standardów kodu PHP sprawdź ten wpis GitHub.

Inne sniffery kodu zaplecza

Twórcy backendów pracują w różnych językach poza PHP, a ich liczba rośnie z każdym rokiem. W językach alternatywnych mamy także alternatywne biblioteki do sniffingu kodu, takie jak sniffer kodu dla Pythona.

Możliwe jest sprawdzenie innych skryptów online lub użycie narzędzi takich jak PyLint. Ale to kolejna metodologia, która wymaga cierpliwości do pracy nad rozwojem.

Deweloperzy Ruby mają również do wyboru szereg opcji lintowanie i analiza kodu. Najlepsze są zawsze wolne i otwarte źródła, takie jak Ruby Lint, statyczny analizator kodu zbudowany dla nowoczesnego kodu Ruby.

Nie znalazłem jeszcze dedykowanego sniffera kodu Node.js, ale mam nadzieję, że projekt pojawi się z czasem. Istnieją sniffery kodu JS, które obsługują standardy Node, ale wciąż jest to nowszy język zaplecza i wymaga czasu na rozwój.

Wreszcie mamy składnię SQL używaną dla baz danych. Ten kod może być trudniejszy, ponieważ trudno jest znaleźć dobrze obsługiwane standardy składni kodu źródłowego SQL. Ale znalazłem webapp formatujący SQL, który powinien okazać się niezwykle przydatny przy optymalizacji zapytań do baz danych.

Zakończyć

Najlepszym miejscem na rozpoczęcie wąchania kodu jest jeden język i jeden standard. HTML / CSS jest łatwym miejscem do uruchomienia dla programistów frontendowych, podczas gdy PHP jest często ulubionym wyborem wśród deweloperów zaplecza (szczególnie programistów WordPress).

A jeśli chcesz dowiedzieć się więcej, zapoznaj się z tymi pokrewnymi postami dotyczącymi wąchania kodu, lintowania i automatycznej analizy kodu w celu optymalizacji.

Dlaczego potrzebujesz standardów kodowania
Code Smells Jeffa Atwooda
Kod PHP Sniffer: Instalacja i konfiguracja
Wprowadzenie do CodeSniffer (część 1)
GitHub Showcase: Czyszczenie kodu Linters