Чистий javascript.Змінні

Переклад книги Раяна Макдермота чистий код адаптованої під javascript.
Зміст:
image

Використовуйте значущі і вимовляти імена змінних

Погано:
const yyyymmdstr = moment().format('YYYY/MM/DD');

Добре:
const yearMonthDay = moment().format('YYYY/MM/DD');

Використовуйте один і той самий метод для того ж типу змінної

Погано:
getUserInfo();
getClientData();
getCustomerRecord();

Добре:
getUser();

Використовуйте іменовані значення

Ми будемо читати код частіше, ніж ми коли-небудь напишемо. Важливо писати читається код, який легко шукати. Робіть ваші імена для пошуку. Такі інструменти, як buddy.js, ESLint можуть допомогти ідентифікувати неназвані константи.

Погано:
// Що значить 86400000?
setTimeout(() => {
this.blastOff();
}, 86400000);

Добре:
// Оголошуйте їх як глобальні змінні.
const MILLISECONDS_IN_A_DAY = 86400000;

setTimeout(() => {
this.blastOff();
}, MILLISECONDS_IN_A_DAY);


Використовуйте пояснювальні змінні

Погано:
const address = 'One Infinite Loop, Cupertino 95014';
const cityStateRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
saveCityState(address.match(cityStateRegex)[1], address.match(cityStateRegex)[2]);

Добре:
const address = 'One Infinite Loop, Cupertino 95014';
const cityStateRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
const [, city, state] = address.match(cityStateRegex);
saveCityState(city, state);

Використовуйте очеловеченные назви

Явне краще, ніж неявне.

Погано:
const locations = ['Austin', 'New York', 'San Francisco'];
locations.forEach((l) => {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
// Що значить `l`?
dispatch(l);
});

Добре:
const locations = ['Austin', 'New York', 'San Francisco'];
locations.forEach((location) => {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
dispatch(location);
});

Не додавайте непотрібний контекст

Якщо ваше ім'я класу / об'єкта каже вам що це, не повторюйте теж при іменуванні його властивостей і методів.

Погано:
const Car = {
carMake: 'Honda',
carModel: 'Indigo',
carColor: 'Blue'
};

function paintCar(car) {
car.carColor = 'Red';
}

Добре:
const Car = {
make: 'Honda',
model: 'Indigo',
color: Blue'
};

function paintCar(car) {
car.color = 'Red';
}

Використовуйте умови за замовчуванням замість коротких замикань або умовних виразів

Погано:
function createMicrobrewery(name) {
const breweryName = name || 'Hipster Brew Co.';
// ...
}

Добре:
function createMicrobrewery(breweryName = 'Hipster Brew Co.') {
// ...
}

Джерело: Хабрахабр

0 коментарів

Тільки зареєстровані та авторизовані користувачі можуть залишати коментарі.