de Meet Zaveri

Ce este boilerplate și de ce îl folosim? Necesitatea ghidului de stil de codificare

Ce este boilerplate si de ce il folosim Necesitatea ghidului

În Tehnologia informației, un cazan este o unitate de scriere care poate fi refolosită mereu și fără modificări. Prin extensie, ideea este uneori aplicată programării reutilizabile, ca în „codul boilerplate”.

Acordurile legale, inclusiv termenii și condițiile software și hardware, utilizează abundent cazanele.

De exemplu, un avocat vă poate da un contract de cinci pagini pentru a semna, dar cea mai mare parte a contractului este de tip boilerplate – ceea ce înseamnă că este același pentru toți cei care primesc acel contract, cu doar câteva rânduri schimbate aici și acolo.

În programarea computerului, codul cazanului sau cazan se referă la secțiuni de cod care trebuie incluse în multe locuri, cu puține sau deloc modificări. Este adesea folosit atunci când se referă la limbi care sunt luate în considerare detaliat, adică programatorul trebuie să scrie o mulțime de cod pentru a face lucrări minime.

ad-banner

De exemplu, în dezvoltarea web, simpla boilerplate pentru HTML ar arăta astfel:

<!DOCTYPE html>                       <html class="no-js" lang="">                           <head>                                 <meta charset="utf-8">                                 <meta http-equiv="x-ua-compatible" content="ie=edge">         <title></title>                                 <meta name="description" content="">                           <meta name="viewport" content="width=device-width, initial- scale=1, shrink-to-fit=no"> <link rel="stylesheet" href="https://www.freecodecamp.org/news/whats-boilerplate-and-why-do-we-use-it-let-s-check-out-the-coding-style-guide-ac2b6c814ee7/css/main.css"></head>                           <body>                                 <p>Hello world! This is HTML5 Boilerplate.</p>               <script src="js/vendor/modernizr-{{MODERNIZR_VERSION}}.min.js>     </script>
 </body></html>

Puteți vizualiza întregul depozit aici:

h5bp / html5-boilerplate
html5-boilerplate – Un șablon front-end profesional pentru a crea aplicații sau site-uri web rapide, robuste și adaptabile.github.com

În anii 1890, placa de cazan a fost de fapt turnată sau ștampilată în metal, pregătită pentru tipografie și distribuită presei de ziare și firmelor din Statele Unite. Până în anii 1950, mii de ziare au primit și au folosit acest tip de cazan de la cel mai mare furnizor al națiunii, Western Newspaper Union. Unele companii au trimis, de asemenea, comunicate de presă sub formă de cazan, astfel încât acestea să fie tipărite după cum se scrie.

1611701108 734 Ce este boilerplate si de ce il folosim Necesitatea ghidului

Majoritatea dezvoltatorilor web profesioniști au creat o colecție de active și fragmente de cod pe care le reutilizează în proiecte pentru a accelera dezvoltarea. Există câteva modele universale sau aproape universale pe care toate site-urile le partajează în comun. În loc să le reconstruiască continuu, majoritatea dezvoltatorilor încep prin a copia codul pe care l-au folosit pentru un proiect similar și apoi îl modifică.

Unii dezvoltatori recunosc valoarea acestor șabloane de pornire a boilerplate și își iau timpul pentru a face boilerplate mai generică și le partajează online pentru ca alții să le poată folosi.

Acest lucru nu se limitează doar la dezvoltarea web. Este folosit dincolo de AI / ML, deoarece există mai multe cadre și biblioteci în creștere.

Caracteristicile necesare ale cazanului pentru proiecte mari (pregătit pentru producție)

  • Documentație bună și lizibilă?
  • Structura codului cu un nivel de abstractizare mai profund
  • Urmează standardul de codare adecvat
  • Are instrument CLI (pentru prototipare și configurare rapidă)
  • Scalabil?
  • Instrumente de testare ușoare
  • Module API necesare
  • Sprijin pentru internaționalizare și localizare?
  • Împărțirea codului
  • Cod server și client pentru configurare
  • Structură de navigare și rutare adecvată?

După toate aceste specificații minime, ar trebui să începeți editarea și modificarea codului pentru a vă construi proiectul.

Există unele companii de tehnologie mare care chiar își construiesc propriul cazan. Îl folosesc pentru proiecte respective și similare de-a lungul timpului.

Un exemplu perfect pentru aceasta ar fi boilerplate-ul react.js:

react-boilerplate / react-boilerplate
react-boilerplate -: foc: o fundație extrem de scalabilă, offline, cu cea mai bună experiență de dezvoltator și un accent …github.com

Cazan pentru proiecte mai mici (Schele)

Aceste tipuri de cazane sunt în general un fel de „Seturi de start” sau în mod profesional se numește „Schele”. Principalii lor utilizatori țintă sunt dezvoltatorii începători sau noii adoptatori timpurii.

Se concentrează pe prototiparea rapidă prin crearea elementelor care sunt necesare doar pentru proiecte noi. Acestea necesită mai puține funcționalități și nu sunt scalabile în timp și proiect.

Structura codului lor nu este mult extinsă și nu implică un strat de abstractizare mai profund, deoarece utilizatorii trebuie doar să construiască caracteristici de bază. Acest lucru elimină necesitatea unor utilități suplimentare.

1611701108 181 Ce este boilerplate si de ce il folosim Necesitatea ghidului
Structura codului

Cel mai simplu exemplu este boilerplate-ul Facebook create-react-app:

facebookincubator / create-react-app
create-react-app – Creați aplicații React fără configurație de compilare.github.com

Care este diferența dintre un cazan și un șablon?

La fel de Joachim Pense afirmă clar, cazan este ceva pe care îl copiați și lipiți și doar îl adăugați la un document. Apare cel mai adesea în contracte în care limba este utilizată și reutilizată, explicând lucruri precum condiții și avertismente.

Scriitorii folosesc șabloane ca modele, uneori cu efecte negative. În termeni generali, un șablon este un model sau model utilizat pentru a crea obiecte noi. În scris, este un formă standardizată de ceva de genul unui CV pe care scriitorii le pot folosi pentru a-și concretiza propriile versiuni.

Spre deosebire de boilerplates, șabloanele sunt adaptate pentru o anumită utilizare. Problema mi-a apărut atunci când elevii au folosit șabloane Word pentru CV-uri și toți au ajuns să arate la fel.

Atât șabloanele, cât și plăcile pot face ca scrierea de afaceri să fie ștearsă și artificială dacă este folosită în mod neînțelept.

Ghid de stil pentru scrierea codului

Indiferent dacă utilizați boilerplate sau nu, există câteva standarde urmate de companii pentru scrierea codului. Unul dintre ei este Ghid stilistic. Încearcă să explice stilurile și modelele de bază care sunt utilizate în diferite companii sau organizații. În general, este o regulă ca angajații să adopte ghidul stilului de codificare al companiei lor.

1611701108 631 Ce este boilerplate si de ce il folosim Necesitatea ghidului

Ghidul de stil descrie o mulțime de reguli pentru scrierea codului, cum ar fi indentarea filelor și a spațiilor, denumirea variabilelor și funcțiilor, scrierea comentariilor necesare, formatare, structuri de fișiere sursă, folosirea metodei adecvate a structurilor de date, evitarea ridicării, scopingului, instrucțiunilor de control și un mult mai mult.

1611701109 137 Ce este boilerplate si de ce il folosim Necesitatea ghidului

Stilurile de programare se ocupă în mod obișnuit de aspectul vizual al codului sursă cu scopul lizibilității. De mult timp sunt disponibile programe software care formează automat codul sursă, lăsând programatorii să se concentreze asupra numirii, logicii și tehnicilor superioare.

Ca punct practic, folosirea unui computer pentru formatarea codului sursă economisește timp și este posibil să se aplice apoi standardele la nivelul întregii companii dezbateri. (Sursa – Wiki).

Acestea sunt câteva dezbateri comune, cum ar fi: Filele v Spații Război sfânt, alegerea codului IDE perfect, si asa mai departe. Interesant este că te poți implica în aceste dezbateri care se întâmplă mai ales pe Reddit. Puteți participa, de asemenea, la unele dintre stackoverflow Întrebări și răspunsuri.

1611701109 59 Ce este boilerplate si de ce il folosim Necesitatea ghidului
sursă – https://stackoverflow.blog/2017/06/15/developers-use-spaces-make-money-use-tabs/

Pentru dezvoltatorii web, cel mai comun ghid de stil pentru JS este Ghidul de stil javascript al Airbnb. Este open source și toată lumea poate contribui.

airbnb / javascript
javascript – Ghid de stil JavaScriptgithub.com

Dacă cineva are dubii cu privire la motivele pentru care Javascript are nevoie de un ghid de stil, atunci citiți al doilea răspuns al acestei ediții de către Harrison Shoff, cine este programator la Airbnb .

De ce JavaScript are nevoie de un ghid de stil? · Numărul nr. 102 · airbnb / javascript
Una dintre părțile mele preferate despre comunitatea JavaScript este că oamenii aleg să o scrie în atât de multe moduri diferite …github.com

Iată câteva ghiduri de stil pentru unele dintre limbile mai populare de astăzi:

DotNet Code Formatter

Java: Google-Java-Format

Stil standard Javascript (diferit de javascriptul airbnb)

Standarde de codare PHP Fixer

Python: YAPF de la Google

Rubin: Rubocop

Mai multe de la Boilerplate: Concept pentru OOP

În programe orientate obiect, clasele sunt adesea prevăzute cu metode pentru obținerea și setarea variabile de instanta. Definițiile acestor metode pot fi frecvent considerate ca un cazan.

Deși codul va varia de la o clasă la alta, structura este suficient de stereotipă încât să fie generată mai bine automat decât scrisă manual.

De exemplu, în cele ce urmează Java clasa reprezentând un animal de companie, aproape tot codul este un cazan, cu excepția declarații de Animal de companie, Nume, și proprietar:

public class Pet {    private String name;    private Person owner;
public Pet(String name, Person owner) {        this.name = name;        this.owner = owner;    }
public String getName() {        return name;    }
public void setName(String name) {        this.name = name;    }
public Person getOwner() {        return owner;    }
public void setOwner(Person owner) {        this.owner = owner;    }}

Definiția cazanului devine din ce în ce mai globală în multe alte limbaje de programare în zilele noastre. Provine din OOP și limbaje hibride care au fost cândva procedurale, dar care au devenit OOP. Acum au același scop de a repeta codul pe care îl construiți cu un model / șablon / clasă / obiect, așa că adoptă acest termen. Creați un șablon, iar singurele lucruri pe care le faceți pentru fiecare instanță a unui șablon sunt parametrii individuali.

Această parte este ceea ce numim boilerplate. Pur și simplu reutilizați codul din care ați făcut un șablon, dar cu parametri diferiți.

Boilerplate ca API

Întrucât pur și simplu reutilizați codul șablon cu parametri diferiți, acest lucru implică faptul că am putea crea API reutilizabile care au nevoie doar de o schimbare a intrărilor și a ieșirilor.

Concluzie

„Codul Boilerplate” este orice cod aparent repetitiv care apare din nou și din nou pentru a obține un rezultat care pare că ar trebui să fie mult mai simplu.

Am scris acest articol pentru că am fost instruit recent de un conducător de echipă să aflu despre numeroasele soiuri de boilerplate care ar putea fi potrivite pentru proiectul nostru. Așa că a trebuit să merg la o căutare a cazanului perfect.

Orice tip de feedback va fi apreciat! Hustle On!