Рубрики
Без рубрики

На повествование кода

Предварительный секрет редактора: Это пост от одного из разработчиков в команде ксила. Пока не особенно п … Теги с стилем, именами, Python.

Предвещение редактора : Это пост от одного из разработчиков в команде ксила. Несмотря на то, что не особенно уместно для мобильного маркетинга, это отличная витрина нашей культуры и страсть членов нашей команды, поэтому мы решили его включить. В статье также выгодно быть красноречивым в избытке и по-настоящему восхитительственным для чтения – настолько, что оно требует своего предисловия. В любом случае, достаточно от меня. Наслаждаться! – Джейкобская кость

Ясность в типах и именах члена может составлять разницу между затяжными и скучными периодами ознакомления, когда один член команды должен понимать чужую логику и короткие, но сладкие исследования.

ТОО помещена ли я выбрать то, что, кажется, самое чистое и прошедшее имя, например Коллектор , только чтобы вскоре понять, что это может означать множество различных референтов в зависимости от специализации и настроения читателя.

Код как метафора

В то время как почти все метафоры, если они продлеваются бесконечно, сломаются под собственный вес и раздавить волю читателя, они дают несколько преимуществ при использовании решительно и в ядре архитектуры:

  • Уменьшенное столкновение терминологии и идентификаторов благодаря однозначному дикции, которое является альтернативой уже перегруженным общим терминам.
  • Лучшее удержание кода знакомства из-за цвета и характера, ведущего часто сухой и повторяющийся синтаксис.
  • Улучшенный умственный моральный моральный муравье от веселья или, предпочтительно, добродушный юмор (а не письменные избиения).

Сама вещь

Чтобы привести пример, я недавно помог создать структуру SCRAPING WEB, чтобы собрать данные из служб, которые, хотя и технически доступны клиентам, было заметно опущено от API и в противном случае сделало так трудоемко для доступа к тому, что представляют собой вредную нагрузку на ресурсы моего работодатель.

Мы назвали проектом Распадор Как мы увлекаемся испанскими именами проекта. Хотя подходит для проектов, перевод термина – код, который может быть непрозрачным для кого-то незнакомого с выбранным языком. На контрастной метафоре, если не неясно, придает уникальный характер, используя знакомые слова.

Для Распадор Мы выбрали воздушную боевую терминологию, включая Пилот , Боеприпасы и Маневра (Чей единственный недостаток – это предпочтение моих пальцев UE над ЕС ). Мы могли бы выбрать Конфигурация , Данные и Этап Как общие аналогии на эти термины, но последние имеют столько слоев предыдущего и разнообразного использования, что читатель должен сначала раскопать их корневой смысл из-под кучи воспоминаний, затем переосмыслению этой абстракции в контексте скребка.

Как мой нежный читатель уже может знать, Пилот присутствует на протяжении всей миссии и является личным, I.e. Профиль пользователя, участвующая; Боеприпасы загружен, переносится и развернут, составляющий данные, специфичные для Scrape AT; и а Маневра Это одно действие полет, ориентированное на конкретную цель, например, нажав на элемент ссылки для доступа к данным отчета.

Одна вещь в модерации

Код, как в сужественстве технически не требует гарнира или приправа; И все же без него каждая строка и каждый день могут смешаться серые в следующую, исчезают видение продукта. Пока код наполнено повествованием, может стать обременительным или просто невысоким образом – мы не имели имя локальных переменных A10 или даже варфон (Модели самолета или прозвища) – это выгода для разработчиков и продукта, оказывающих, что обеспечивает реализацию в условиях ароматных, со вкусом и специфическими для хранения логики и процесса как на трассе, так и в живых.

Оригинал: “https://dev.to/lfmyr/on-code-narrative-3056”