Написание чистого кда это не самая легкая задача. Новичок в мире программирования жет и не справиться с этой задачей, так как здесь потребуются знания многих материалов и лайфхаков. Конечно такой информации на просторах Интернета очень много и порой нет времени изучать, мониторить и выбирать лучшее, поэтому мы выбрали 5 сам действенных советов для написания чистого кода,которыми пользуются многие веб - разработчики.
Читабельный код.
Всем понятно, что написанный нами код в дальнейшем обрабатывает машина и мы можем писать его в одну или две строки. Если в вашем коде нет изъянов, машина легкостью будет его читать. Но существует и вероятность того, что кто - то также захочет работать с ним, либо же вы сами вернетесь к нему. Поэтому в наших же интересах создать изначально чистый код. Один из простейших способов - применения пробелов и табуляции. Используйте познавательные символ кода - скобки, пробелы, пустые строки. Это поможет поддержать читабельность кода.
Приведем наглядный пример:
Плохой
const userData=[{userId: 1, userName: 'Anthony Johnson', memberSince: '08-01-2017', fluentIn: [ 'English', 'Greek', 'Russian']},{userId: 2, userName: 'Alice Stevens', memberSince: '02-11-2016', fluentIn: [ 'English', 'French', 'German']},{userId: 3, userName: 'Bradley Stark', memberSince: '29-08-2013', fluentIn: [ 'Czech', 'English', 'Polish']},{userId: 4, userName: 'Hirohiro Matumoto', memberSince: '08-05-2015', fluentIn: [ 'Chinese', 'English', 'German', 'Japanese']}];
Чистый
const userData = [
{
userId: 1,
userName: 'Anthony Johnson',
memberSince: '08-01-2017',
fluentIn: [
'English',
'Greek',
'Russian'
]
}, {
userId: 2,
userName: 'Alice Stevens',
memberSince: '02-11-2016',
fluentIn: [
'English',
'French',
'German'
]
}, {
userId: 3,
userName: 'Bradley Stark',
memberSince: '29-08-2013',
fluentIn: [
'Czech',
'English',
'Polish'
]
}, {
userId: 4,
userName: 'Hirohiro Matumoto',
memberSince: '08-05-2015',
fluentIn: [
'Chinese',
'English',
'German',
'Japanese'
]
}
]
Применение понятных слов для переменных и функций.
Вам необходимо использовать такие слова для названия функций и переменных, чтобы взглянув на них мы могли сразу же понять их значение. То есть название должно содержать понятные слова, при этом не составляя длины предложения. Не более 3 - 4 слов. Если вы применяете больше, лучше разделить их на несколько задач.
Составляйте код, чтобы функция выполняла лишь 1 задачу.
Избавьтесь от написания функции, которая одновременно должна выполнять несколько задач. В противном случае вам потребуется:
- придумать ей название;
- скорее всего кроме вас никто не поймет что именно она выполняет;
- через время и вам будет трудно разобраться в том, что вы написали;
- запутанный код.
В случае если вы разделите большую функцию на маленькие задачи вы получите несколько преимуществ:
- другие будут понимать ваш код;
- название станет читабельным;
- функция станет предсказуемой.
Пользуйтесь комментариями и пояснениями.
Помните, что для многих других разработчиков ваш код может быть непонятным несмотря на то, что вы очень ответственно подошли к этой задаче. Вся проблема может заключаться в том что им не понятна сама суть реализации функции или метода. Разработчику не понятна идея и смысл для чего необходим ваш код.
Порой необходимо нестандартно решать ту или иную проблему, и самой сложной задачей становиться объяснение с помощью кода. В этом случае нам помогут комментарии внутри кода. Они расскажут для чего мы писали код. Также другие программисты могут предложить свои варианты решения проблемы, чтобы усовершенствовать ваш код. Комментарии важно оставлять только там, где это необходимо, а не под каждой строчкой.
Постоянно проверяйте код.
Если вы написали действительно чистый код это еще не значит , что работа закончена.Далее необходимо проводить рефакторинги и постоянно улучшать свой код. Если вы проигнорируете это, то со временем он просто устареет и станет ненужным.
Эти советы подойдут для более опытных веб - разработчик нежели для новичков. Реализуя хотя бы несколько из них на своей практике, вам удастся написать действительно чистый код.