Улучшение удобочитаемости кода и удобства обслуживания

Копилот Чат Могу предложить способы сделать ваш код проще для понимания и поддержания.

В этой статье

Код с низкой удобочитаемостью сложно для других разработчиков поддерживать и расширять их. Копилот Чат Может помочь разными способами. Например, вы можете:

Документирование кода — это еще один способ повысить удобство обслуживания кода. Для информации о том, Копилот Чат как использовать полезные комментарии к вашему коду, смотрите примеры запросов в разделе «Документирование кода».

Примечание.

Ответы, показанные в этой статье, являются примерами. Копилот Чат Ответы не детерминированы, поэтому вы можете получить другие ответы, чем показаны здесь.

Улучшение имен переменных

Описательные имена переменных и имена параметров упрощают понимание их назначения.

Пример сценария

Этот код JavaScript записывает сообщение о возрасте человека в консоль. Абстрактные имена параметров затрудняют понимание цели кода.

function logPersonsAge(a, b, c) {
  if (c) {
    console.log(a + " is " + b + " years old.");
  } else {
    console.log(a + " does not want to reveal their age.");
  }
}

Пример запроса

В редакторе выберите функцию, которую хотите изменить, затем спросите Копилот Чат:

Copilot prompt
Improve the variable names in this function

Пример ответа

Copilot предлагает описательные имена переменных.

function logPersonAge(name, age, revealAge) {
  if (revealAge) {
    console.log(name + " is " + age + " years old.");
  } else {
    console.log(name + " does not want to reveal their age.");
  }
}

Избегайте последовательных условных проверок

if...else цепочки могут быть трудными для чтения, особенно если они длинные.

Пример сценария

Этот код Python печатает звук, который делают различные животные, если определено, или "Неизвестное животное", если тип животного не распознается. Однако цепочка if...else операторов делает код неэффективным и громоздким.

class Animal:
    def speak(self):
        pass

class Dog(Animal):
    def speak(self):
        return "Woof!"

class Cat(Animal):
    def speak(self):
        return "Meow!"

class Bird(Animal):
    def speak(self):
        return "Tweet!"

def animal_sound(animal_type):
    if animal_type == "dog":
        return Dog().speak()
    elif animal_type == "cat":
        return Cat().speak()
    elif animal_type == "bird":
        return Bird().speak()
    else:
        return "Unknown animal"

print(animal_sound("dog"))
print(animal_sound("cat"))
print(animal_sound("bird"))
print(animal_sound("fish"))

Пример запроса

Copilot prompt
Simplify this code. Avoid using if/else chains but retain all function return values.

Пример ответа

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

class Animal:
    def speak(self):
        pass

class Dog(Animal):
    def speak(self):
        return "Woof!"

class Cat(Animal):
    def speak(self):
        return "Meow!"

class Bird(Animal):
    def speak(self):
        return "Tweet!"

def animal_sound(animal_type):
    animals = {
        "dog": Dog,
        "cat": Cat,
        "bird": Bird
    }
    animal_class = animals.get(animal_type, Animal)
    return animal_class().speak() if animal_class != Animal else "Unknown animal"

print(animal_sound("dog"))
print(animal_sound("cat"))
print(animal_sound("bird"))
print(animal_sound("fish"))

Сокращение вложенной логики

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

Пример сценария

Этот код Ruby выводит сведения о учетной записи пользователя на основе трех параметров. Использование вложенных if...else инструкций делает код ненужным сложным.

def determine_access(user_role, has_permission, is_active)
  if user_role == "admin"
    if has_permission
      if is_active
        "Active admin account with full access."
      else
        "Inactive admin account."
      end
    else
      "Admin account lacks necessary permissions."
    end
  else
    "Access denied."
  end
end

puts determine_access("admin", true, true)
puts determine_access("admin", true, false)
puts determine_access("admin", false, true)
puts determine_access("user", true, true)

Пример запроса

Copilot prompt
Rewrite this code to avoid the nested if/else statements

Пример ответа

Copilot Рекомендуется использовать защитные оговорки для ранней обработки условий и возврата соответствующих сообщений.

def determine_access(user_role, has_permission, is_active)
  return "Access denied." unless user_role == "admin"
  return "Admin account lacks necessary permissions." unless has_permission
  return "Inactive admin account." unless is_active

  "Active admin account with full access."
end

puts determine_access("admin", true, true)
puts determine_access("admin", true, false)
puts determine_access("admin", false, true)
puts determine_access("user", true, true)

Разделение больших методов

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

Пример сценария

Этот метод Java обрабатывает заказ клиента и выводит сообщение. Он выполняет несколько задач в одном методе.

public void processOrder(Order order) {
  if (order == null || order.getItems().isEmpty()) {
    throw new IllegalArgumentException("Order is invalid.");
  }

  double totalPrice = 0.0;
  for (Item item : order.getItems()) {
    totalPrice += item.getPrice() * item.getQuantity();
  }
  order.setTotalPrice(totalPrice);

  if (totalPrice > 0) {
    order.setStatus("Processed");
  } else {
    order.setStatus("Pending");
  }

  System.out.println("Order for customer " + order.getCustomerName() + " has been processed. Total price: " + totalPrice);
}

Пример запроса

Copilot prompt
How could the processOrder method be refactored to be more useful and easier to maintain

Пример ответа

Copilot предлагает разбить этот метод на более мелкие, сфокусированные методы.

public void processOrder(Order order) {
    validateOrder(order);
    double totalPrice = calculateTotalPrice(order);
    updateOrderStatus(order, totalPrice);
    printOrderSummary(order, totalPrice);
}

private void validateOrder(Order order) {
    if (order == null || order.getItems().isEmpty()) {
        throw new IllegalArgumentException("Order is invalid.");
    }
}

private double calculateTotalPrice(Order order) {
    double totalPrice = 0.0;
    for (Item item : order.getItems()) {
        totalPrice += item.getPrice() * item.getQuantity();
    }
    order.setTotalPrice(totalPrice);
    return totalPrice;
}

private void updateOrderStatus(Order order, double totalPrice) {
    if (totalPrice > 0) {
        order.setStatus("Processed");
    } else {
        order.setStatus("Pending");
    }
}

private void printOrderSummary(Order order, double totalPrice) {
    System.out.println("Order for customer " + order.getCustomerName() + " has been processed. Total price: " + totalPrice);
}

Дополнительные материалы