Що таке шаблонний шаблон і навіщо ми його використовуємо? Необхідність керівництва стилем кодування

В інформаційних технологіях шаблонний шаблон - це блок письма, який можна повторно використовувати знову і знову без змін. Як розширення, ідея іноді застосовується до програмування, що використовується багаторазово, як у "типовому коді".

Юридичні угоди, включаючи програмні та апаратні умови, широко використовують котли.

Наприклад, адвокат може дати вам підписати контракт на п’ять сторінок, але більша частина контракту є типовою - це означає, що він однаковий для всіх, хто отримує цей контракт, лише де-не-де змінивши кілька рядків.

У комп'ютерному програмуванні шаблонний код або шаблонний шаблон відноситься до розділів коду, які мають бути включені в багатьох місцях з незначними або без змін. Він часто використовується при посиланні на мови, які вважаються багатослівними , тобто програміст повинен написати багато коду, щоб виконувати мінімальні завдання.

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

Hello world! This is HTML5 Boilerplate.

Ви можете переглянути ціле сховище тут:

h5bp / html5-шаблон

html5-sampleplate - Професійний інтерфейсний шаблон для створення швидких, надійних та адаптивних веб-програм або веб-сайтів. github.com

У 1890-х роках зразки фактично відливали або штампували в металі, готовому для друкарні, і розповсюджувались у газетних пресах та фірмах по Сполучених Штатах. До 50-х років тисячі газет отримували та використовували такий зразок від найбільшого постачальника в країні - Західної газетної спілки. Деякі компанії також розсилали прес-релізи як зразки, щоб їх слід було надрукувати у письмовому вигляді.

Більшість професійних веб-розробників створили колекцію активів та фрагментів коду, які вони повторно використовують для проектів, щоб пришвидшити розробку. Існує кілька універсальних або майже універсальних шаблонів, якими поділяються всі веб-сайти. Замість того, щоб постійно відновлювати їх, більшість розробників починають з копіювання коду, який вони використовували для подібного проекту, а потім починають його модифікувати.

Деякі розробники визнають цінність цих шаблонних шаблонів для початківців і витрачають час, щоб зробити шаблонний шаблон більш загальним та поділитися ним в Інтернеті, щоб інші могли ним користуватися.

Це обмежується не лише веб-розробкою. Він використовується в AI / ML, оскільки існує більше зростаючих фреймворків та бібліотек.

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

  • Хороша та читабельна документація?
  • Структура коду з більш глибоким рівнем абстракції
  • Дотримується правильного стандарту кодування
  • Має інструмент CLI (для швидкого прототипування та налаштування)
  • Масштабована?
  • Прості інструменти тестування
  • Необхідні модулі API
  • Підтримка інтернаціоналізації та локалізації?
  • Розбиття коду
  • Код сервера та клієнта для налаштування
  • Правильна структура навігації та маршруту?

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

Є деякі великі технологічні компанії, які навіть створюють власні зразки. Вони використовують його для відповідних та подібних проектів протягом усього часу.

Ідеальним прикладом для цього може бути шаблонний шаблон response.js:

реагувати-шаблонний / реагувати-шаблонний

реагувати на шаблон -: fire: Високомасштабний, перший в автономному режимі фундамент з найкращим досвідом для розробників та фокусом… github.com

Котло для менших проектів (риштування)

Цей тип котлів, як правило, є різновидом “Стартових наборів”, або по-професійному це називається “Ліси”. Їх основними цільовими користувачами є початківці розробники або нові користувачі, які вперше застосували.

Він зосереджений на швидкому прототипуванні, створюючи елементи, необхідні лише для нових проектів. Вони вимагають меншої функціональності і не є масштабованими з часом та проектом.

Їх структура коду не набагато розширена і не передбачає глибшого рівня абстракції, оскільки користувачам потрібно лише створити основні функції. Це позбавляє потреби в додаткових комунальних послугах.

Найпростіший приклад - шаблон Facebook-create-response-app:

facebookincubator / create-response-app

create-response-app - Створюйте програми React без конфігурації збірки. github.com

Яка різниця між шаблоном та шаблоном?

Як Joachim Pense чітко вказано, що шаблонний є те , що ви скопіювати і вставити і просто додати в документ. Найчастіше це трапляється в контрактах, де мова використовується та використовується повторно, вказуючи такі речі, як умови та застереження.

Автори використовують шаблони як моделі , іноді з негативними ефектами. У загальних рисах шаблон - це модель або шаблон, що використовується для створення нових об’єктів. У письмовій формі це стандартизована форма чогось на зразок резюме, яке автори можуть використовувати для розробки власних версій.

На відміну від котлів, шаблони пристосовані для певного використання. Проблема виникла у мене, коли студенти використовували шаблони Word для своїх резюме, і в результаті вони виглядали однаково.

Як шаблони, так і шаблони можуть зробити бізнес-письмо холодним і штучним, якщо їх використовувати нерозумно.

Керівництво стилем для написання коду

Незалежно від того, використовуєте ви шаблонний шаблон чи ні, компанії існують деякі стандарти написання коду. Одним з них є « Керівництво стилем». Він намагається пояснити основні стилі та моделі, які використовуються в різних компаніях чи організаціях. Як правило, правило, що співробітники повинні приймати керівництво стилем кодування своєї компанії.

Посібник із стилю описує безліч правил для написання коду, таких як відступ табуляції та пробілів, іменування змінних та функцій, написання необхідних коментарів, форматування, структуру вихідних файлів, використовуючи належний метод структур даних, уникаючи підняття, масштабування, операторів управління та набагато більше.

Стилі програмування зазвичай мають справу з візуальним виглядом вихідного коду з метою читабельності. Давно доступне програмне забезпечення, яке автоматично форматує вихідний код, залишаючи кодерам зосереджуватися на іменуванні, логіці та вищих методах.

З практичної точки зору, використання комп’ютера для форматування вихідного коду економить час, і тоді можна без суперечок дотримуватись стандартів на рівні всієї компанії. (Джерело - Wiki).

Ось деякі загальні дебати, такі як: Tabs v Spaces Священна війна , вибір ідеального IDE коду тощо. Цікаво те, що ви можете брати участь у цих дебатах, які в основному відбуваються на Reddit . Ви також можете взяти участь у деяких запитаннях та відповідях stackoverflow .

Для веб-розробників найпоширенішим посібником стилю для JS є посібник стилю JavaScript від Airbnb. Це відкритий код, і кожен може зробити свій внесок.

airbnb / javascript

javascript - Посібник зі стилів JavaScript github.com

Якщо хтось сумнівається, чому Javascript потребує посібника зі стилю, то прочитайте другу відповідь цього випуску Гаррісона Шоффа, програміста Airbnb .

Навіщо JavaScript потрібен керівництво стилем? · Випуск № 102 · airbnb / javascript

Однією з моїх улюблених частин про спільноту JavaScript є те, що люди вирішили писати це так багато різних способів ... github.com

Ось декілька посібників щодо стилів для деяких популярних сьогодні мов:

Форматник коду DotNet

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

Стандартний стиль Javascript (відрізняється від JavaScript airbnb)

Виправлення стандартів кодування PHP r

Python: YAPF від Google

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

Більше від Boilerplate: Концепція ООП

В об'єктно-орієнтованих програмах класи часто забезпечуються методами отримання та встановлення змінних екземпляра. Визначення цих методів часто можна розглядати як шаблон.

Хоча код відрізнятиметься від одного класу до іншого, він досить стереотипний за структурою, щоб його було б краще генерувати автоматично, ніж писати від руки.

Наприклад, у наступному класі Java, що представляє домашнього улюбленця, майже весь код є шаблонним, крім декларацій про Pet , ім’я та власника :

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, які потребують лише зміни входів і виходів.

Висновок

«Код таблички» - це будь-який, здавалося б, повторюваний код, який з’являється знову і знову, щоб отримати результат, який, здається, повинен бути набагато простішим.

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

Будь-який відгук буде вдячний! Метушня!