Имя для нас свято. Раз или два в жизни нам выпадает случай назвать новорожденного. Мы хотим, чтобы имя было уникальным, осмысленным и чтобы люди обращали на него внимание. Инженер делает это 50–100 раз в день. Мы называем наши функции, переменные, аргументы, классы, файлы и т. д. и используем их в наших повседневных разговорах и разработке кода. Хорошее имя может помочь вам получить большую прибыль в будущем.
Описательные имена
Имя переменной или функции должно сообщать, почему она существует, что делает, как используется.
Нельзя
let date = moment().subtract(7, 'days'); // date 7 days ago;
Дополнения
let dateSevenDaysAgo = moment().subtract(7, 'days');
Избегайте дезинформации
Избегайте слов, которые затемняют смысл, дают ложную подсказку или выглядят похоже.
Нельзя
let x, acc; // obscure variables
Дополнения
let account;
Неинформативные имена
Избегайте имен, которые добавляют шума или не содержат информации в именах переменных.
Нельзя
let a1, a2, x, y, z; // Number-series naming
findByIds() OR findByIdsPromise() OR findwithRequestIds()
Выберите одно слово для каждой концепции
Выберите одно слово для одного абстрактного понятия и придерживайтесь его.
Нельзя
reqCreated or createReq
fetch, retrieve, and get
Дополнения
/getItem, /createItem, /updateItem
Если вы программист, начинающий карьеру в профессиональном мире, или менеджер, желающий оказать серьезное влияние на команду, прочтите хорошую книгу о качестве кода. Я рекомендую Чистый код Роберта К. Мартина.
Вот и все, и если вы нашли эту статью полезной, пожалуйста, нажмите кнопку хлопка 👏
