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

Итак, я столкнулся с проблемой Как написать код, который хорошо читается, прост для понимания и доставляет удовольствие в обслуживании?

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

  1. Использовать правильное имя переменной: выберите значение полного имени для переменной. Поэтому, когда кто-то читает программу, он/она поймет хорошо и будет благодарен. Также избегайте общих имен, таких как temp, resp, бла-бла. Напишите имя переменной, которое должно передавать то, что вы пытаетесь сделать? что должно быть? для чего. избегайте использования типа данных в качестве имени переменной, например list, dict. Я думаю, что мы должны использовать существительное, глаголы для таких переменных, как размер, цена. Также имя функции должно быть похоже на make_account, get_size.
  2. разделяй и властвуй: разделяй программу на небольшие независимые модули и функции.
  3. Пусть одна функция хорошо справляется с одной задачей: не делайте беспорядка в функции, она должна быть независимой.
  4. Добавляйте комментарии для пояснения сложной части программного обеспечения: всегда старайтесь добавлять комментарии к части кода, которую сложно понять. убедитесь, что при добавлении комментария он должен добавлять ценность вашему коду.