5 главных ошибок, которые программисты будут совершать в 2021 году Перевод

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

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

Хотите по-настоящему фантазировать? Есть несколько хороших проектов, которые помогут вам писать документацию, например docusaurus.

Ошибка 2: без комментариев

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

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

Ошибка 3: нечитаемый код

Вы когда-нибудь тратили несколько часов на то, чтобы прочитать фрагмент кода и понять, что он делает (особенно, когда нет комментариев — см. Ошибку 2)! У каждого разработчика был такой момент, когда он не понимал, что делает прочитанный код.

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

Ошибка 4: нет теста

Еще одна главная ошибка — никогда не проводить никаких модульных или интеграционных тестов.

Конечно, вы протестировали свой код вручную и убедились, что он работает на вашей машине. Но нет никакой гарантии, что вы или ваш коллега будете выполнять те же тесты и что код будет выполняться в чистой среде (например, в конвейере CI/CD).

Чтобы гарантировать, что ваш код по-прежнему работает должным образом, напишите модульные тесты и запускайте их при каждом изменении в конвейере CI/CD.

Ошибка 5: не используйте строгий ввод, когда он доступен

Многие языки, используемые сегодня (например, JavaScript или Python), не используют строгую типизацию. К счастью, они решают эти проблемы.

Строгий набор позволяет избежать ошибок и гарантирует, что вы не добавляете яблоки и апельсины. Даже сегодня некоторые разработчики все еще добавляют строки и целые числа, ожидая, что "1" + 1 в Javascript будет равно 2 (предупреждение, оно равно 11).

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