У меня были трудности с написанием чистого кода. Но серия постов в Medium очень помогла. Итак, вот ссылки на публикации и мои выводы из Части 1, Части 2, Части 3 и Части 4 из серии Написание чистого кода, которыми стоит поделиться. Логешвар Л.
- Избегайте избыточной информации. Например: UserWithNameAndAge является более избыточным и очень длинным. Предпочитать пользователя
- Соблюдайте соглашения об использовании регистров в соответствии с языком, который вы используете. Пример: camelCase в Java/Javascript, snake_case в Python и так далее.
- Будьте последовательны в именовании ваших переменных/методов. Пример: избегайте использования getAge(), fetchName(), retrieveMail(). Вместо этого будьте последовательны и назовите их getAge(), getName() и getMail().
- Избегайте сленга, непонятных сокращений и дезинформации (указывающей на неправильную структуру данных в имени переменной и т. д.).
- Избегайте комментариев, которые говорят очевидное или вводят в заблуждение.
- Никогда не комментируйте код, просто удалите.
- Используйте комментарии только в том случае, если вы хотите предоставить информацию о лицензировании, предупреждения или если вам необходимо предоставить документацию по API.
- Используйте комментарии, когда код трудно понять с одного взгляда, и это упростит его, предоставив некоторые комментарии в качестве пояснений (например, регулярное выражение).
- Правильно форматируйте код, добавляя пустые строки для разделения несвязанных понятий и группируя похожие/связанные понятия вместе.
- Не пишите нечитаемо длинную строку кода или имени в одной строке. Разделите их на несколько строк и используйте точные короткие имена.
- Пишите функции с минимальным количеством параметров.
- Делайте свои функции простыми для чтения и понимания без написания сотен строк кода внутри одной функции. Вместо этого разделите на несколько коротких функций.
- Подумайте о разделении функций, но будьте благоразумны.
- Увеличьте возможность повторного использования и сделайте код СУХИМ (не повторяйтесь).
- Старайтесь не смешивать разные уровни абстракции в функции.
- Избегайте неожиданных побочных эффектов.
- Проверьте, упрощает ли ваша функция модульное тестирование.
Это выводы, которые вы можете прочитать в сообщениях блога. После прочтения постов. Я надеюсь, что мы все можем ответить на вопрос выше, что Да! Мы можем писать чистый код с практикой и советами, представленными в сообщениях блога.
Я рекомендую вам прочитать каждый пост, так как он предоставляет полезные примеры и подробные шаги / советы по реализации написания чистого кода.
Я обязательно вернусь к этим постам, когда буду писать коды.
Богу слава!
