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

В будущем я намерен написать о передовом опыте, связанном с объектно-ориентированным программированием. Это будет немного более продвинуто. Давайте начнем.

1. Определите код

Я считаю отступы кода одним из самых основных и в то же время необходимых элементов для программиста, будь то начинающий или продвинутый. Тот факт, что мы определяем область действия условий IF, WHILE и т. д., делает код намного проще для понимания, а также делает его более красивым.

У меня очень серьезный дефект, каким бы простым ни был код, но если он без отступов, я не могу ничего прочитать, не говоря уже о том, чтобы что-то понять. Это даже похоже на «нервный тик», но я почти невольно начинаю ставить некоторые пробелы в коде.

2. Интуитивно понятное наименование переменных

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

Такого рода проблемы можно найти в циклах, использующих вложенные циклы FOR, где обычно встречаются счетчики с именами x, y, z и т. д., переменные и даже имена структур, таких как массивы. Можно найти «причудливые» имена.

3. Избегайте условий отказа в IF

Программирование без управления потоком с использованием условий «ЕСЛИ» практически невозможно. Идея состоит в том, чтобы всегда оценивать, является ли условие истинным в условии выполнения определенного кода.

По этой причине по возможности избегайте использования проверок отрицания условия, по возможности сначала оценивая истинное условие, а если оно ложно, выполняйте код «ELSE». Это также делает код более читаемым и менее запутанным, когда у нас есть вложенные «IF».

4. Называть функции интуитивно понятным способом

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

Например, в моих объектно-ориентированных или необъектно-ориентированных скриптах у меня есть привычка называть функции, возвращающие значения типа BOOLEAN, всегда начинающиеся с «is», эта практика делает вызов функции внутри «IF» более интуитивным.

5. Прокомментируйте код

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

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

6. Стандартизировать имя константы

Константы — это значения, которые нельзя изменить во время выполнения приложения, поэтому они заслуживают выделения в наших системах.

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

7. Используйте try, catch и блоки

Работа с кодом внутри try, catch и блоков даже считается хорошей практикой безопасности. Например, если в PHP-скрипте возникает ошибка подключения к базе данных, где не используется try..catch, в некоторых ситуациях на странице будет напечатано имя базы данных.

Кроме того, управляя ИСКЛЮЧЕНИЯМИ вашего приложения, вы можете отображать сообщения, более интуитивно понятные пользователю, избегая тех сообщений на «английском языке», которые являются стандартными для большинства языков программирования.

8. Не используйте значение по умолчанию в аргументах функции

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

Вместо обработки недопустимого значения аргумента вместо использования значения по умолчанию

9. Выполняйте циклы только при необходимости

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

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

Дополнительные материалы на PlainEnglish.io. Подпишитесь на нашу бесплатную еженедельную рассылку новостей. Подпишитесь на нас в Twitter, LinkedIn, YouTube и Discord.