Как написать «Чистый код»?

При работе в команде или если вам нужно пересмотреть свой код в будущем, чистый код упрощает чтение и понимание. Это поможет вам сэкономить время и усилия и избежать ошибок.

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

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

В этой статье я дам вам несколько важных советов по написанию чистого кода.

Поддерживайте единый формат и стиль
Это поможет вам избежать ошибок и сделает ваш код более легким для чтения и понимания. Чтобы сохранить единообразие, подумайте о том, чтобы принять руководство по стилю, например, предлагаемое Google.

Плохая практика:

const DAYS_IN_WEEK = 7;
const daysInMonth = 30;

const songs = ["Back In Black", "Stairway to Heaven", "Hey Jude"];
const Artists = ["ACDC", "Led Zeppelin", "The Beatles"];

function eraseDatabase() {}
function restore_database() {}

class animal {}
class Alpaca {}

Хорошая практика:

const DAYS_IN_WEEK = 7;
const DAYS_IN_MONTH = 30;

const SONGS = ["Back In Black", "Stairway to Heaven", "Hey Jude"];
const ARTISTS = ["ACDC", "Led Zeppelin", "The Beatles"];

function eraseDatabase() {}
function restoreDatabase() {}

class Animal {}
class Alpaca {}

2. Используйте простые описательные имена для своих классов, функций и переменных.
Используйте только известные и общепринятые сокращения и однобуквенные имена.

Плохая практика:

const yyyymmdstr = moment().format("YYYY/MM/DD")

Хорошая практика:

const currentDate = moment().format("YYYY/MM/DD")

3. Чтобы упорядочить код и упростить его чтение, используйте пробелы и отступы.
Использование пустых строк для разделения кода на отдельные разделы и отступы для иллюстрации порядка условных операторов и циклов — два примера как это сделать.

Плохая практика:

function linearSearch(array: number[],value: number): boolean{
    for(let i=0;i<array.length;i++){
    if (array[i] === value) return true;
    }
 return false;
}

Хорошая практика:

function linearSearch(array: number[], value: number): boolean {
    for (let i = 0; i < array.length; i++) {
        if (array[i] === value) return true;
    }

    return false;
}

4. Чтобы дать больше контекста и пояснений, прокомментируйте свой код.
При работе в группе или если вам нужно вернуться и просмотреть свой код позже, это может быть чрезвычайно полезно.

Плохая практика:

function hashIt(data) {
  // The hash
  let hash = 0;

  // Length of string
  const length = data.length;

  // Loop through every character in data
  for (let i = 0; i < length; i++) {
    // Get character code.
    const char = data.charCodeAt(i);
    // Make the hash
    hash = (hash << 5) - hash + char;
    // Convert to 32-bit integer
    hash &= hash;
  }
}

Хорошая практика:

function hashIt(data) {
  let hash = 0;
  const length = data.length;

  for (let i = 0; i < length; i++) {
    const char = data.charCodeAt(i);
    hash = (hash << 5) - hash + char;

    // Convert to 32-bit integer
    hash &= hash;
  }
}

5. Сохраняйте свой код организованным и модульным.
Разделив его на компактные повторно используемые классы и функции. В результате ваш код проще тестировать, поддерживать и повторно использовать в других проектах.

Плохая практика:

function emailClients(clients) {
  clients.forEach(client => {
    const clientRecord = database.lookup(client);
    if (clientRecord.isActive()) {
      email(client);
    }
  });
}

Хорошая практика:

function emailActiveClients(clients) {
  clients.filter(isActiveClient).forEach(email);
}

function isActiveClient(client) {
  const clientRecord = database.lookup(client);
  return clientRecord.isActive();
}

6. Сохраняйте код простым и понятным.
Вместо этого стремитесь к ясности и простоте. В результате ваш код будет проще читать, понимать и поддерживать.

Будь простым и ленивым.

7. Протестируйте свой код, чтобы убедиться, что он точен и не содержит ошибок.
Таким образом вы сможете выявлять проблемы по мере их возникновения и не допускать их перерастания в более серьезные проблемы.

Вывод:

В целом, важно учитывать читабельность и удобство сопровождения при написании кода. Вы можете убедиться, что ваш код прост для понимания и работы с ним сейчас и в будущем, придерживаясь этих рекомендаций и лучших практик.

Спасибо за прочтение!

Оставляйте хлопки, комментируйте и делитесь с коллегами и друзьями.

Как написать «Чистый код»?

Вопросы по теме