Prečo potrebujete kódy Sniffers pre vývoj webu

Optimalizácia kódu je porovnateľná s edičnou fázou písania. Možno budete musieť najprv dostať vaše nápady dole v kóde, ale váš kód by mal byť optimalizovaný pomocou nástrojov, ako je kód sniffers aby sme vyrobili čo najlepší produkt.

Kódové čuchanie je termín, ktorý popisuje kontrolný kód na dodržiavanie regulačných noriem. Tieto predpisy môžu špecifikovať počet medzipriestorov, ktoré sa majú použiť na odsadenie, umiestňovanie kučeravých zátvoriek alebo spôsoby menovania premenných. Normy nie sú pre budovanie webovej aplikácie nevyhnutné, ale štandardy sú dôležité pre vnútornú konzistenciu a údržbu kódu.

To je miesto, kde kód sniffing prichádza do praxe pre všetkých vývojárov, frontend na backend. rád by som preskúmať proces čuchania kódu a ponúknuť niektoré nástroje, ktoré pomáhajú analyzovať štandardy kódu.

Čo je kód čuchanie?

Činnosť čuchania kódu je typicky automatizovaná na šetrí čas a znižuje chyby. Kód sniffers bude skontrolovať zdrojové kódy pre súlad s normami stanovené internými vývojovými tímami alebo regulačnými orgánmi.

Kódovanie chĺpkov je podobné kódovaniu, ale šetrnejšie. Hlavné lakovanie kontroly chýb a syntaktických chýb zatiaľ čo čuchanie hľadá problémy v je napísaný kód cesty. Súbor PHP môže aj naďalej správne fungovať, ale zlyhá testovanie kódu, ak názov premennej nerešpektuje štandardy (napr. $ myVariable proti $ my_variable).

Podobná terminológia je kódový zápach, ktorý kontroluje chyby v návrhu v kóde, ktorý môže viesť k väčším chybám. To sa môže týkať kódových noriem, ale zahŕňa aj architektúry vyššej úrovne pre písanie homogénneho kódu.

Všetky tieto oblasti stojí za to pokryť a sú relevantné pre kódovanie čuchania. Len majte na pamäti, že čuchanie kód nie vždy nájde chýb pri spustení pretože je jeho prioritou dodržiavanie prísnych noriem.

Doteraz by ste sa mohli pýtať sami seba, či už ide o štandardy? Pravdou je, že záleží, ale viac na optimalizáciu a vyčistenie projektu. Mnohí vývojári súhlasia s tým, že štandardy sú nevyhnutné pre programovanie a vývoj webových aplikácií - predovšetkým pre veľké tímové projekty.

Tu je citát vývojára Paula Jonesa, ktorý vysvetľuje, prečo sú štandardy kódov užitočné.

“Bod štandardu štýlu kódovania neznamená, že jeden štýl je objektovo lepší než iný ... Namiesto toho ide o vytvorenie známych očakávaní o tom, ako kód bude vyzerať.”

Ak vytvárate malý webapp pre seba, nemusia stáť za to čas na štandardy WCAG 2.0 alebo PSR-2. Ale zvážte stovky vývojárov pracujúcich na zdrojovom kóde Adobe Photoshopu. Bolo by chaotické, keby každý človek napísal svoj vlastný štýl a spojil to všetko dohromady.

Aj keď sa tímy silne spoliehajú na štandardy, tieto pravidlá môžu byť aj pre osamelých vývojárov užitočné. Môžete nájsť kódové štandardy pre všetko od CSS po WordPress, takže nie je žiadna zámienka, aby ste sa nepokúsili zistiť, či sa kvalita vášho kódu zlepšila.

Hodnota štandardov kódov

Normy budú prirodzene Udržujte svoj kód čistý a organizovaný. Vývojári presne vedia, ako napísať kód a ako postupovať spolu so svojou prácou.

Normy týkajúce sa kódov tiež pomáhajú rozvoju otvoreného zdroja tým, že ponúkajú pravidlá pre ostatných. Súbory je možné vyzdvihnúť o niekoho mesiace alebo roky neskôr a stále sa dajú ľahko čítať.

Prísne štýl kódovania je dobrý nápad aj keď sa rozhodnete vytvoriť svoj vlastný. Vyžaduje to veľa úsilia, ale keďže projekty rastú, takýto typ dokumentácie je neoceniteľný.

Tu sú niektoré štandardy kódovania, ktoré uvažujú o rozložení rôznych jazykov.

• PEAR kódovacie štandardy (PHP)
• Normy Google pre HTML / CSS
• Normy Google pre JavaScript
• Django štýl kódovania (Python)
• Rails štýl sprievodca (Ruby)
• WCAG 2.0 (UX)

Najlepšie zdroje čuchania kódu

Teraz je možné nájsť zadarmo kód sniffers pre všetko od HTML / CSS k backend jazyky ako PHP a SQL. Možno nebudete musieť používať tieto snifery alebo dodržiavať štandardy pre každý jazyk, ale stojí za to preskúmať možnosti, ako zistiť, čo môže zlepšiť váš výkon.

Číreň kód Sniffers

Aj keď HTML nie je potrebovať kód sniffer, ktorý nezastavil Squiz od vybudovania jedného. Je to úplne otvorený zdroj a hosťuje na GitHub s možnosťou kopírovať / prilepiť kód do prehliadača alebo uložiť bookmarklet pre spustenie na jednotlivých webových stránkach.

Tento kontrolór kontroluje tri úrovne prístupu A, AA a AAA tri úrovne WCAG spolu s časťou 508 usmernení, ktoré sa uplatňujú predovšetkým na vládnych webových stránkach.

CSS vývojárom sa môže páčiť tento bezplatný kódový sniffer kódu CSS, ktorý je tiež otvorený zdroj, ktorý je hosťovaný prostredníctvom správcu balíkov uzlov.

Používatelia jQuery by sa mali pozrieť na JSCodeSniffer, ktorý vytvoril Dmitrij Sheiko. Toto je ďalší bezplatný webapp hosťujúci na GitHub, ktorý je v súlade s príručkou štýlu kódu jQuery.

Prípadne by ste sa chceli pokúsiť linting váš JS kód s JavaScript Lint alebo JS Lint. Tieto nástroje skontrolujú skôr chyby v syntaxe než kódy, ale sú tiež veľmi užitočné, pokiaľ ide o optimalizáciu kódu frontend.

Pre záznam je možné skontrolovať štandardy JS / CSS priamo pomocou PHP_CodeSniffer.

PHP kód Sniffer

PHP_CodeSniffer je nevyhnutným nástrojom vo vašom nástroji, ak sa snažíte dodržiavať štandardy kódu PHP. Balíček obsahuje niekoľko PHP skripty, ktoré analyzujú kód PHP, JS a CSS s vašou voľbou dokumentácie štýlu kódu.

Tvorca PHP_CodeSniffer Greg Sherwood napísal úžasný príbeh o tom, ako sa myšlienka objavila a aké problémy sa pokúša vyriešiť (stojí za to čítať, ak máte čas).

Stručne povedané, Greg pracoval s tímom, ktorý sa učil s jazykom JavaScript a stal sa PHP aplikáciou. Ich cieľom bolo štruktúrovať JS tak, aby nasledovali kódové štandardy PHP, aby sa uľahčilo prepínanie medzi nimi. Tak sa narodil PHP_CodeSniffer.

To je skvelé pre vývojárov PHP, pretože jazyk je veľmi voľný s povinnými požiadavkami na štýl. Rámce, ako je Laravel, sú prísnejšie, ale vývojári môžu (a mali by) nastaviť svoje vlastné štandardy kódov bez toho, aby sa spoliehali na rámec tretích strán.

Rôzne štandardy ako PSR-0, PSR-1 a PSR-2 sú všetky populárne a zabalené s knižnicou PHP sniffing.

Ale môžete nájsť veľa ďalších predpripravených štandardov pre PHP CMS ako WordPress, Magento a Drupal. Vývojári v jadre Drupal dokonca vydali oficiálny kódový modul sniffer s názvom Coder.

PHP je nepochybne najjednoduchší jazyk na optimalizáciu pomocou kódu sniffers. Ak hľadáte zoznam štandardov kódu PHP pozrite sa na túto položku GitHub.

Ostatné Backend Code Sniffers

Vývojári Backend pracujú s rôznymi jazykmi mimo PHP a čísla sa každý rok zvyšujú. S alternatívnymi jazykmi máme aj alternatívne kódy sniffing knižnice, ako je kódovanie pre Python.

Je možné skontrolovať iné skripty online alebo použiť nástroje ako PyLint. Ale toto je ďalšia metodika, ktorá vyžaduje trpezlivosť, aby pracovala vo vašom vývoji.

Ruby devs tiež majú rad možností, pokiaľ ide o kódovanie a analýza. Najlepšie sú vždy zadarmo a open source ako Ruby Lint, statický kódový analyzátor postavený na modernom Ruby kóde.

Ešte som nájsť dedikovaný kód Node.js, ale dúfam, že sa projekt objaví s časom. Existujú JS kódové sniffery, ktoré podporujú štandardy uzlov, ale stále je to novší podporný jazyk a vyžaduje čas na rast.

Napokon máme pre databázy SQL syntax. Tento kód môže byť oveľa zložitejší, pretože je ťažké nájsť dobre podporované syntaktické štandardy pre zdrojový kód SQL. Ale našiel som webový formát na formátovanie SQL, ktorý by sa mal pri optimalizácii databázových dopytov veľmi užitočne ukázať.

Zabaliť

Najlepšie miesto pre štartovanie kódu je jeden jazyk a jeden štandard. HTML / CSS je jednoduché miesto pre vývojárov frontend, zatiaľ čo PHP je často obľúbenou voľbou medzi vývojármi backendov (najmä WordPress devs).

A ak sa chcete dozvedieť viac, pozrite si tieto súvisiace príspevky na kódovanie, čuchanie a automatickú analýzu kódu pre optimalizáciu.

• Prečo potrebujete štandardy kódovania
• Kód vôňa Jeffa Atwooda
• PHP Code Sniffer: Inštalácia a konfigurácia
• Úvod do programu CodeSniffer (časť 1)
• GitHub Showcase: Čističe kódov