Miért van szükség a kód kifejlesztésére a webfejlesztéshez
A kód optimalizálása hasonló az írás szerkesztési fázisához. Előfordulhat, hogy először meg kell kapnia az ötleteket a kódban, de a kódot olyan eszközökkel kell optimalizálni, mint például kód szippantás a legjobb termék előállításához.
A kód szippantása egy kifejezés, amely leírja a szabályozási szabványoknak való megfelelés ellenőrzése. Ezek a szabályok meghatározhatják a bemélyedéshez, a göndör zárójelek elhelyezéséhez vagy a változók megnevezéséhez használt terek számát. A szabványok nem nélkülözhetetlenek egy webalkalmazás létrehozásához, de a szabványok fontosak belső konzisztencia és kódkarbantartás érdekében.
Ez az a hely, ahol a kód szippantás jön be minden fejlesztőnek, a backendhez. szeretnék vizsgálja meg a kód szippantás folyamatát és kínáljon néhányat segédprogramok, amelyek segítenek a kód szabványok elemzésében.
Mi a kód szippantása?
A kód szippantás hatása általában automatizált időt takaríthat meg és csökkentheti a hibákat. Kód szippantás lesz ellenőrizze, hogy a forráskódok megfelelnek-e a szabványoknak belső fejlesztési csoportok vagy szabályozó testületek által meghatározott.
A kód szippantása hasonló a kódoláshoz, de sokkal pedánsabb. Elsősorban foszlás ellenőrzi a hibákat és a szintaxis hibákat miközben szippantás keresi a problémákat az út kódja. A PHP fájl továbbra is megfelelően működik, de nem sikerül egy kód szippantási tesztet elvégezni, ha a változó neve nem követi a szabványokat (azaz. $ myVariable vs $ my_variable).
Hasonló terminológia a kódszag, amely ellenőrzi a tervezési hibákat a kódban, amely nagyobb hibákat eredményezhet. Ez a kódszabványokra is vonatkozik, de magában foglalja a magasabb szintű architektúrák homogén kódok írásához.
Mindezen területeket érdemes lefedni, és fontosak a szippantás kódolásához. Ne feledje, hogy a szippantási kód nem mindig találja a futásidejű hibákat mivel a prioritás a szabványok szigorú betartása.
Mostanra talán megkérdeznéd magadnak, hogy a szabványok is számítanak-e? Az igazság az, hogy számítanak, de inkább az optimalizálás és a projektek tisztítása szempontjából. Sok fejlesztő egyetért abban, hogy a szabványok elengedhetetlenek a programozáshoz és a webfejlesztéshez - különösen a nagy csapatprojekteknél.
Itt van egy idézet a Paul Jones fejlesztőtől, amely elmagyarázza, miért hasznosak a kódszabványok.
“A kódolási stílus standardja nem azt jelenti, hogy az egyik stílus objektíven jobb, mint egy másik… Ahelyett, hogy a kódot megnézhetjük, a lényeg az, hogy ismertessük az elvárásokat.”
Ha egy kis weblapot építesz magadnak, előfordulhat, hogy nem érdemes időt tölteni a WCAG 2.0 vagy a PSR-2 szabványokon. De fontolja meg, hogy a több száz fejlesztő dolgozik az Adobe Photoshop forráskódjában. Kaotikus lenne, ha minden személy saját stílusát írta volna össze, és mindegyikük összeillesztené.
Bár a csapatok nagymértékben támaszkodnak a szabványokra, ezek a szabályok még mindig hasznosak lehetnek a magányos fejlesztők számára is. A CSS-től a WordPress-hez mindent megtalálhat, így nincs kifogás, hogy megpróbálja megnézni, hogy javul-e a kód minősége.
A kódszabványok értéke
A szabványok természetesen tartsa tisztán és rendezetten a kódját. A fejlesztők pontosan tudják, hogyan kell írni a kódot és hogyan kövessék egymás munkáját.
A kódszabványok a nyílt forráskódú fejlesztést is segítik a szabályok követése mellett. A fájlokat bárkinek vagy évvel később felveheti, és könnyen olvasható.
A szigorú kódolási stílus jó ötlet még akkor is, ha úgy dönt, hogy saját készít. Ez sok erőfeszítést igényel, de mint projektek, az ilyen típusú dokumentáció felbecsülhetetlen.
Íme néhány kódolási szabvány, amely figyelembe veszi, hogy a különböző web-nyelvek köre van.
- PEAR kódolási szabványok (PHP)
- Google szabványok HTML / CSS számára
- A Google JavaScript-szabványai
- Django kódolási stílus (Python)
- Rails Style Guide (Ruby)
- WCAG 2.0 (UX)
A legjobb kód szippantás
A HTML / CSS-től a backend nyelvekhez, például a PHP-hez és az SQL-hez mindent megtalálhatunk, ahol ingyenes kódot találhatsz. Előfordulhat, hogy nem kell ezeket a szippantókat használni, vagy követnie kell az egyes nyelvekre vonatkozó szabványokat, de érdemes megvizsgálni annak lehetőségét, hogy miként javíthatja a teljesítményt.
Elülső kód szaggatott
Bár a HTML nem szükség egy kód, amelyik nem állította le Squiz-et az épületből. Teljesen nyílt forráskódú, és a GitHub-on tárolja a kódokat a böngészőbe másolás / beillesztés lehetőségeivel, vagy könyvjelzőt menthet az egyes weboldalakon történő futtatáshoz.
Ez a komolyabb ellenőrzés a WCAG három, A, AA és AAA akadálymentesítési szabványának szintjével szemben, valamint az 508 szakasz iránymutatásai, amelyek elsősorban a kormányzati webhelyekre vonatkoznak.
A CSS-fejlesztők tetszeni fogják ezt a szabad CSS-kódot, amely szintén nyílt forráskódú, a Csomópont-csomagkezelőn keresztül.
A jQuery felhasználóknak meg kell nézniük a Dmitrij Sheiko által épített JSCodeSniffert. Ez egy másik ingyenes webapp, amely a GitHub-on található, amely megfelel a jQuery kódstílus-útmutatójának.
Alternatívaként érdemes megpróbálnod a JS kódodat a JavaScript Lint vagy a JS Lint segítségével. Ezek az eszközök a szintaxis helyett hibakódokat keresnek, mint a kód szabványok, de nagyon hasznosak a frontend kód optimalizálásakor is.
A felvételhez a JS / CSS szabványokat is közvetlenül a PHP_CodeSniffer segítségével lehet ellenőrizni.
A PHP kód Sniffer
A PHP_CodeSniffer a szerszámboltban kötelező eszköz, ha megfelel a PHP-kód szabványoknak. A csomag tartalmaz néhányat PHP, JS és CSS kódot elemző PHP szkriptek a megfelelés érdekében a kódstílus dokumentációjának megválasztásával.
A PHP_CodeSniffer Greg Sherwood alkotója csodálatos hátteret írt arról, hogyan jött létre az ötlet, és milyen problémákat próbál megoldani (érdemes elolvasni, ha van ideje).
Összefoglalva, Greg egy PHP alkalmazásba épített csapattanulási JavaScript-szel dolgozott. Céljuk az volt, hogy a JS-et olyan módon alakítsák ki, hogy kövesse a PHP kódszabályait, hogy az élet könnyebbé váljon az oda-vissza. Így született meg a PHP_CodeSniffer.
Ez nagyszerű a PHP fejlesztők számára, mert a nyelv nagyon laza a kötelező stíluskövetelményeknek. Az olyan keretrendszerek, mint a Laravel, szigorúbbak, de a fejlesztők (és meg kell adniuk) a saját kódszabványaikat, anélkül, hogy egy harmadik fél keretrendszerére támaszkodnának.
Különböző szabványok, mint a PSR-0, a PSR-1 és a PSR-2, mind népszerűek és csomagolva vannak a PHP szippantó könyvtárával.
A PHP CMS-hez hasonlóan számos más előre elkészített kódszabványt találhatsz, mint a WordPress, a Magento és a Drupal. A Drupal core fejlesztői még egy kódkódú hivatalos kódot is kiadtak.
A PHP kétségtelenül a legkönnyebben használható nyelv a kódszaggatók optimalizálásához. Ha keres a PHP kód szabványok listája nézd meg ezt a GitHub bejegyzést.
Egyéb Backend Code Sniffers
A háttérfejlesztők a PHP-n kívül különböző nyelveken dolgoznak, és a számok évről évre nőnek. Alternatív nyelvek mellett alternatív kód szippantó könyvtárak is vannak, mint például a Python kódkódja.
Lehetőség van más szkriptek online ellenőrzésére vagy olyan eszközök használatára, mint a PyLint. De ez egy másik módszertant igényel, amely türelmet igényel a fejlesztés folyamán.
A Ruby devs-nek is számos választása van kódolás és elemzés. A legjobbak mindig szabad és nyílt forráskódúak, mint a Ruby Lint, a modern Ruby kódra épített statikus kódelemző.
Még nem találtam egy dedikált Node.js kódot, de remélem, hogy a projekt idővel fel fog merülni. Vannak JS kódok, amelyek támogatják a Node szabványokat, de még mindig egy újabb backend nyelv, és időt igényel a növekedésre.
Végül az adatbázisokban SQL szintaxist használunk. Ez a kód trükkös lehet, mivel nehéz megtalálni a jól támogatott szintaxis szabványokat az SQL forráskódhoz. De találtam egy SQL formázó weblapot, amely rendkívül hasznosnak bizonyulhat az adatbázis lekérdezések optimalizálásakor.
Csomagolja fel
A legjobb hely a kód szippantásához az egyik nyelv és egy szabvány. A HTML / CSS egy egyszerű hely a frontend fejlesztők elindításához, míg a PHP gyakran kedvelt választás a backend fejlesztők között (különösen a WordPress devs).
És ha többet szeretne megtudni, tekintse meg ezeket a kapcsolódó bejegyzéseket a kód szippantás, szöszelés és automatizált kódelemzés során az optimalizáláshoz.
- Miért van szüksége a kódolási szabványokra?
- Kód szagolja Jeff Atwood
- PHP kód Sniffer: Telepítés és konfiguráció
- Bevezetés a CodeSniffer-be (1. rész)
- GitHub bemutató: Clean Code Linters