Proč potřebujete kód Sniffers pro vývoj webových aplikací

Optimalizace kódu je srovnatelná s editační fází psaní. Nejdříve budete muset své nápady dostat do kódu, ale váš kód by měl být optimalizován pomocí podobných nástrojů čtečky kódů produkt.

Kódový sniffing je termín, který popisuje kontroly dodržování norem. Tyto předpisy mohou specifikovat počet mezer, které se mají použít pro odsazení, umístění složených závorek nebo jak pojmenovat proměnné. Standardy nejsou důležité pro tvorbu webové aplikace, ale důležité jsou standardy vnitřní konzistenci a údržbu kódu.

Toto je místo, kde kód sniffing přijde vhod pro všechny vývojáře, frontend na backend. rád bych prozkoumat proces čichání kódu a nabídnout některé nástroje, které pomáhají analyzovat standardy kódů.

Co je čichání kódu?

Činnost čichání kódu je typicky automatizovaná šetří čas a snižuje chyby. Kód sniffers bude zkontrolovat zdrojové kódy pro dodržování norem interních vývojových týmů nebo regulačních orgánů.

Kód sniffing je podobný kódování lining ale více pedantic. Primární obložení kontroluje chyby a chyby syntaxe při čichání hledají problémy způsob zápisu kódu. Soubor PHP může stále fungovat správně, ale nezdaří test čichání kódu, pokud název proměnné nesplňuje standardy (tj. $ myVariable vs $ my_variable).

Podobná terminologie je kódový pach, který kontroluje vady návrhu v kódu, který může vést k větším chybám. To se může týkat norem kodexu, ale také zahrnuje architektury vyšší úrovně pro psaní homogenního kódu.

Všechny tyto oblasti stojí za to pokrývat a jsou relevantní pro kódové čichání. Mějte na paměti, že ten čichající kód nebude vždy najít runtime chyby jeho prioritou dodržování přísných norem.

Teď už se můžete ptát, zda jsou normy dokonce důležité? Pravdou je, že na tom záleží, ale více na optimalizaci a vyčištění projektu. Mnoho vývojářů souhlasí s tím, že standardy jsou pro programování a vývoj webových aplikací nezbytné - zejména na velkých týmových projektech.

Zde je citace od vývojáře Paula Jonesa, který vysvětluje, proč jsou kódové normy užitečné.

“Smyslem standardu stylu kódování není říci, že jeden styl je objektivně lepší než jiný… Namísto toho je třeba nastavit známá očekávání o tom, jak bude kód vypadat..”

Pokud stavíte malou webovou stránku pro sebe, nemusí to být čas strávený na standardech WCAG 2.0 nebo PSR-2. Ale zvažte stovky vývojářů, kteří pracují na zdrojovém kódu Adobe Photoshopu. Bylo by chaotické, kdyby každá osoba napsala svůj vlastní styl a spojila ji dohromady.

I když se týmy silně spoléhají na standardy, tato pravidla mohou být i nadále užitečná i pro samotné vývojáře. Normy kódů naleznete v CSS až po WordPress, takže není důvod se snažit zjistit, zda se kvalita kódu zlepšuje..

Hodnota standardů kódů

Normy budou přirozeně Udržujte svůj kód čistý a organizovaný. Vývojáři přesně vědí, jak psát kód a jak postupovat spolu s ostatními.

Normy kodexu také pomáhají rozvoji open source tím, že nabízejí pravidla pro ostatní. Soubory mohou být vyzvednuty kdekoli měsíce nebo roky později a stále jsou snadno čitelné.

Přísný kódovací styl je dobrý nápad i když se rozhodnete vytvořit si vlastní. To si vyžaduje mnoho úsilí, ale protože projekty rostou, je tento typ dokumentace neocenitelný.

Zde jsou některé standardy kódování, aby zvážila, že rozsah gamut různých webových jazyků.

Normy kódování PEAR (PHP)
Standardy Google pro HTML / CSS
Google Standardy pro JavaScript
Styl kódování Django (Python)
Průvodce stylem Rails (Ruby)
WCAG 2.0 (UX)

Nejlepší zdroje čichání kódu

Nyní je možné najít bezplatné čtečky kódů pro vše od HTML / CSS až po backend jazyky jako PHP a SQL. Možná nebudete muset používat tyto sniffers nebo dodržovat standardy pro každý jazyk, ale stojí za to prozkoumat možnosti, jak zjistit, co by mohlo zlepšit váš výkon.

Čelní kód čichá

Ačkoli HTML ne potřeba kód sniffer, který nezastavil Squiz od stavby jeden. Je to zcela otevřený zdroj a hostuje se na webu GitHub s možnostmi zkopírovat / vložit kód do prohlížeče nebo uložit záložku pro jednotlivé záložky.

Tento sniffer kontroluje tři úrovně standardů WCAG pro přístupnost A, AA a AAA spolu s pravidly sekce 508, které se vztahují především na vládní webové stránky..

Vývojáři CSS by měli rádi tento bezplatný CSS kód sniffer, který je také open source, hostovaný prostřednictvím Node Package Manager.

Uživatelé jQuery by se měli podívat na JSCodeSniffer postavený Dmitry Sheiko. Toto je další bezplatná webová stránka hostovaná na GitHub, která je v souladu s průvodcem kódovým stylem jQuery.

Případně můžete chtít vyzkoušet liniování kódu JS pomocí kódu JavaScript Lint nebo JS Lint. Tyto nástroje kontrolují chyby v syntaxi spíše než v normách kódů, ale jsou také velmi užitečné, pokud jde o optimalizaci kódu frontendu.

Pro záznam je také možné kontrolovat standardy JS / CSS přímo pomocí PHP_CodeSniffer.

PHP kód Sniffer

PHP_CodeSniffer je nástroj, který musíte mít ve svém toolbeltu, pokud chcete vyhovět standardům kódů PHP. Balíček obsahuje několik PHP skripty, které analyzují PHP, JS a CSS kód pro shodu s výběrem dokumentace ve stylu kódů.

Tvůrce PHP_CodeSniffer Greg Sherwood napsal nádhernou zákulisí o tom, jak tento nápad přišel a jaké problémy se snaží vyřešit (stojí za to přečíst, pokud máte čas).

Stručně řečeno, Greg pracoval s týmovým učením JavaScriptu zabudovaným do PHP aplikace. Jejich cílem bylo strukturovat JS způsobem, který sledoval kódové standardy PHP, aby byl život snazší přepínat tam a zpět. Narodil se tak PHP_CodeSniffer.

To je skvělé pro vývojáře PHP, protože jazyk je velmi volný s povinnými požadavky na styl. Rámce jako Laravel jsou přísnější, ale vývojáři mohou (a měli by) nastavovat své vlastní kódové standardy, aniž by se spoléhali na rámec třetí strany..

Různé standardy, jako jsou PSR-0, PSR-1 a PSR-2, jsou všechny populární a baleny s knihovnou PHP sniffing.

Ale můžete najít spoustu dalších pre-made kód standardy pro PHP CMS 'jako WordPress, Magento a Drupal. Vývojáři na Drupal jádru dokonce vydali oficiální kódový sniffer modul s názvem Coder.

PHP je bezesporu nejjednodušším jazykem pro optimalizaci pomocí kódových šňůrek. Pokud hledáte seznam standardů kódů PHP podívejte se na tuto položku GitHub.

Ostatní Backend Code Sniffers

Vývojáři backendu pracují s různými jazyky mimo PHP a jejich počet roste každým rokem. S alternativními jazyky máme také alternativní kódování knihoven jako kód-sniffer pro Python.

Je možné kontrolovat další skripty online nebo používat nástroje jako PyLint. Ale to je další metodika, která vyžaduje trpělivost pracovat ve vašem vývoji.

Ruby devs má také řadu možností, pokud jde o kódování a analýza. Nejlepší z nich jsou vždy zdarma a open source jako Ruby Lint, statický kódový analyzátor postavený pro moderní Ruby kód.

Ještě jsem nenalezl vyhrazený kód Node.js sniffer, ale doufám, že se projekt s časem objeví. Tam jsou JS kód sniffers, které podporují Node standardy, ale je to stále novější backend jazyk a vyžaduje čas k růstu.

Nakonec máme SQL syntaxi používanou pro databáze. Tento kód může být složitější, protože je obtížné nalézt dobře podporované standardy syntaxe pro zdrojový kód SQL. Ale našel jsem webovou stránku pro formátování SQL, která by se měla při optimalizaci databázových dotazů ukázat jako nesmírně užitečná.

Zabalit

Nejlepším místem, kde začít kódovat, je jeden jazyk a jeden standard. HTML / CSS je snadné místo pro vývojáře frontendu, zatímco PHP je často oblíbenou volbou mezi backendovými vývojáři (zejména WordPress devs).

A pokud se chcete dozvědět více, podívejte se na tyto související příspěvky na čichání kódu, linting a automatickou analýzu kódu pro optimalizaci.

Proč potřebujete kódovací standardy
Kód Voní Jeff Atwood
PHP kód Sniffer: Instalace a konfigurace
Úvod do CodeSniffer (část 1)
GitHub Showcase: Vyčistěte kód Linters