Какво представлява бойлер и защо го използваме? Необходимост от ръководство за стил на кодиране

В информационните технологии шаблонният шаблон е единица за запис, която може да се използва отново и отново без промяна. В допълнение, понякога идеята се прилага за програмиране за многократна употреба, както е в „кода на шаблона“.

Правните споразумения, включително софтуерни и хардуерни условия, широко използват котлоните.

Например, адвокат може да ви даде договор за подписване от пет страници, но по-голямата част от договора е примерна - което означава, че е един и същ за всеки, който получи този договор, като тук и там са променени само няколко реда.

В компютърното програмиране кодът на шаблонния шаблон или образец се отнася до раздели на кода, които трябва да бъдат включени на много места с малко или никакви промени. Често се използва, когато се позовава на езици, които се считат за многословни , т.е. програмистът трябва да напише много код, за да изпълнява минимални задачи.

Например, при уеб разработката, простият шаблон за HTML би изглеждал така:

Hello world! This is HTML5 Boilerplate.

Можете да видите цялото хранилище тук:

h5bp / html5-образец

html5 -plateplate - Професионален преден шаблон за изграждане на бързи, стабилни и адаптивни уеб приложения или сайтове. github.com

През 1890-те години, шаблонът всъщност е отливан или щампован в метал, готов за печатарската преса, и разпространен във вестници и фирми в САЩ. До 50-те години на миналия век хиляди вестници получават и използват този вид образци от най-големия доставчик в страната, Западен вестник съюз. Някои компании също изпратиха съобщения за пресата под формата на образец, така че трябваше да бъдат отпечатани така, както са написани.

Повечето професионални уеб разработчици са създали колекция от активи и фрагменти от код, които използват повторно за проекти, за да ускорят развитието. Има някои универсални или почти универсални модели, които всички уебсайтове споделят. Вместо да ги възстановяват непрекъснато, повечето разработчици започват с копиране на кода, който са използвали за подобен проект, и след това започват да го модифицират.

Някои разработчици разпознават стойността на тези шаблони за начални образци и отделят време, за да направят образците по-общи и ги споделят онлайн, за да ги използват други.

Това не се ограничава само до уеб разработка. Той се използва отвъд в AI / ML, тъй като има все повече растящи рамки и библиотеки.

Необходими характеристики на бойлер за големи проекти (готово за производство)

  • Добра и четлива документация?
  • Структура на кода с по-дълбоко ниво на абстракция
  • Следва правилния стандарт за кодиране
  • Има CLI инструмент (за бързо прототипиране и настройка)
  • Мащабируемо?
  • Лесни инструменти за тестване
  • Необходими модули на API
  • Подкрепа за интернационализация и локализация?
  • Разделяне на кода
  • Сървър и клиентски код за настройка
  • Правилна структура за навигация и маршрутизиране?

След всички тези минимални спецификации, трябва да започнете да редактирате и променяте кода, за да изградите своя проект.

Има някои големи технологични компании, които дори изграждат свой собствен модел. Те го използват за съответни и подобни проекти през цялото време.

Перфектен пример за това би бил шаблонът на response.js:

реагиращ котел / реагиращ котел

React-Boatplate -: пожар: Силно мащабируема, първа офлайн основа с най-доброто изживяване за разработчици и фокус ... github.com

Бойлер за по-малки проекти (скеле)

Този тип котлони обикновено са нещо като „Стартови комплекти“ или по професионален начин се нарича „Скелета“. Основните им целеви потребители са начинаещи разработчици или нови раноприети.

Той се фокусира върху бързото прототипиране, като създава елементите, които са необходими само за нови проекти. Те изискват по-малко функционалност и не са мащабируеми с течение на времето и проектирането.

Тяхната кодова структура не е много разширена и не включва по-дълбока абстракция, тъй като потребителите трябва само да изграждат основни функции. Това елиминира нуждата от допълнителни помощни програми.

Най-простият пример е шаблонът на Facebook за създаване на реакция:

facebookincubator / create-response-app

create-response-app - Създайте React приложения без конфигурация на компилация. github.com

Каква е разликата между шаблон и шаблон?

Както ясно казва Йоахим Пенсе, шаблонът е нещо, което копирате и поставяте и просто добавяте към документ. Той се появява най-често в договори, където езикът се използва и използва повторно, като се изписват неща като условия и предупреждения.

Писателите използват шаблони като модели , понякога с негативни ефекти. В най-широк смисъл шаблонът е модел или модел, използван за създаване на нови обекти. В писмен вид това е стандартизирана форма на нещо като автобиография, която писателите могат да използват, за да доработят собствените си версии.

За разлика от бойлетите, шаблоните са адаптирани за определена употреба. Проблемът възникна за мен, когато учениците използваха шаблони на Word за автобиографиите си и в крайна сметка всички изглеждаха еднакво.

И шаблоните, и шаблоните могат да направят бизнес писането стилен и изкуствен, ако се използва неразумно.

Ръководство за стил за писане на код

Независимо дали използвате шаблон или не, има някои стандарти, следвани от компаниите за писане на код. Един от тях е Ръководство за стил. Той се опитва да обясни основните стилове и модели, които се използват в различни компании или организации. Обикновено е правило служителите да приемат ръководството за стил на кодиране на своята компания.

Ръководството за стил описва тонове правила за писане на код, като отстъп на раздели и интервали, именуване на променливи и функции, писане на необходими коментари, форматиране, изходни файлови структури, използване на подходящ метод за структури на данни, избягване на повдигане, обхват, контролни изявления и много повече.

Стиловете на програмиране обикновено се занимават с визуалния външен вид на изходния код с цел четливост. Отдавна се предлага софтуер, който автоматично форматира изходния код, оставяйки кодерите да се концентрират върху именуването, логиката и по-високите техники.

Като практичен момент използването на компютър за форматиране на изходния код спестява време и е възможно след това да се налагат стандарти за цялата компания, без да се обсъждат. (Източник - Wiki).

Това са някои често срещани дебати като: Tabs v Spaces Holy war , избор на перфектния IDE на Code и т.н. Интересното е, че можете да се включите в тези дебати, които се случват най-вече на Reddit . Можете също така да участвате в някои от въпросите и отговорите на stackoverflow .

За уеб разработчиците най-често срещаното ръководство за стил за JS е ръководството за стил на Javascript на Airbnb. Той е с отворен код и всеки може да допринесе.

airbnb / javascript

javascript - JavaScript Style Guide github.com

Ако някой се съмнява защо Javascript се нуждае от ръководство за стил, прочетете втория отговор на този брой от Харисън Шоф, който е програмист в Airbnb .

Защо JavaScript се нуждае от ръководство за стил? · Брой # 102 · airbnb / javascript

Една от любимите ми части за общността на JavaScript е, че хората избират да го напишат по толкова много различни начини ... github.com

Ето някои ръководства за стил за някои от по-популярните днес езици:

DotNet Code Formatter

Java: Google-Java-формат

Javascript стандартен стил (различен от javascript на airbnb)

Фиксиране на стандарти за кодиране на PHP r

Python: YAPF на Google

Рубин: Рубокоп

Още от Boilerplate: Концепция за ООП

В обектно-ориентираните програми класовете често се предоставят с методи за получаване и задаване на променливи на екземпляра. Дефинициите на тези методи често могат да се разглеждат като образци.

Въпреки че кодът ще варира в различните класове, той е достатъчно стереотипен по структура, за да бъде по-добре генериран автоматично, отколкото да се пише на ръка.

Например, в следния клас Java, представляващ домашен любимец, почти целият код е шаблон, с изключение на декларациите за домашен любимец , име и собственик :

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; }}

В днешно време дефиницията на образци става все по-глобална в много други езици за програмиране. Той идва от ООП и хибридни езици, които някога са били процедурни, но са станали ООП. Сега те имат същата цел да повторят кода, който изграждате с модел / шаблон / клас / обект, така че те приемат този термин. Вие правите шаблон и единствените неща, които правите за всеки екземпляр на шаблон, са индивидуалните параметри.

Тази част е това, което ние наричаме шаблон. Просто използвате повторно кода, от който сте направили шаблон, но с различни параметри.

Бойлер като API

Тъй като просто използвате повторно кода на шаблон с различни параметри, това означава, че можем да изградим API за многократна употреба, които се нуждаят само от промяна на входовете и изходите.

Заключение

„Код на бойлер“ е всеки привидно повтарящ се код, който се показва отново и отново, за да се получи резултат, който изглежда, че трябва да е много по-опростен.

Написах тази статия, защото наскоро бях инструктиран от ръководител на екипа да науча за многото разновидности на образци, които може да са подходящи за нашия проект. Така че трябваше да тръгна да търся идеалния шаблон.

Всеки тип обратна връзка ще бъде оценен! Hustle On!