Какие критерии оценки кода в процедурном стиле можно считать хорошими, а какие - плохими?

Хорошие критерии:

• Читаемость: Насколько легко понять, что делает код, читая его сверху вниз.
• Понятность переменных и функций: Использование описательных имен переменных и функций, отражающих их назначение и логику.
• Декомпозиция: Разбиение сложных задач на более мелкие, управляемые функции. Каждая функция должна выполнять одну конкретную задачу.
• Отсутствие глобальных переменных: Минимизация использования глобальных переменных для уменьшения зависимостей и побочных эффектов.
• Обработка ошибок: Явная обработка возможных ошибок и исключений.
• Комментарии: Присутствуют там, где код неочевиден, или для объяснения логики.
• Согласованность стиля: Единый стиль форматирования и именования в рамках всего проекта.
• Минимизация дублирования кода: Избегание повторения одних и тех же блоков кода.

# Хороший пример декомпозиции и понятных имен
def calculate_average(numbers):
    """Calculates the average of a list of numbers."""
    if not numbers:
        return 0
    total = sum(numbers)
    return total / len(numbers)

def process_data(data):
    # Предполагаем, что 'data' - список списков чисел
    averages = []
    for row in data:
        avg = calculate_average(row)
        averages.append(avg)
    return averages

Плохие критерии:

• Непонятность: Код сложно понять из-за запутанной логики, неоптимальных именований или отсутствия структуры.
• "Спагетти-код": Множество переходов и зависимостей, делающих последовательность выполнения трудноотслеживаемой.
• "Лапша"-код: Длинные, монолитные функции, выполняющие множество несвязанных задач.
• Использование "магических чисел": Необъясненные числовые константы в коде.
• Отсутствие обработки ошибок: Программа "падает" при возникновении непредвиденных ситуаций.
• Дублирование кода: Одинаковые или очень похожие блоки кода повторяются в разных местах.
• Несогласованный стиль: Разное форматирование и именование затрудняют чтение.

# Плохой пример "лапши" и магических чисел
def process(d):
    t = 0
    for r in d:
        s = 0
        c = 0
        for n in r:
            s += n
            c += 1
        if c > 0:
            t += s / c
    return t / len(d) if len(d) > 0 else 0

Сравнение: