Побољшајте читљивост и могућност одржавања свог ЈаваСцрипт кода пратећи ове конвенције о именовању.
Од суштинског је значаја да одржавате једноставност, читљивост и лакоћу одржавања у вашем коду како бисте управљали сложеним ЈаваСцрипт пројектима. Доследно придржавање конвенција о именовању кључ је за постизање овог циља.
Променљиве, логичке вредности, функције, константе, класе, компоненте, методе, приватне функције, глобалне променљиве и датотеке су међу ЈаваСцрипт елементима који захтевају доследне конвенције именовања. Можете побољшати организацију и разумевање кода применом стандардизованих конвенција именовања у свим овим компонентама, штедећи време и труд на дужи рок.
1. Именовање променљивих
У ЈаваСцрипт-у, подаци се чувају у променљивим. Неопходно је одабрати описна имена за варијабле која тачно одражавају њихову функцију. Можете, на пример, заменити корисничко име или Укупна цена за име променљиве, а не Икс.
Добар начин за именовање променљивих је следећи:
дозволити тоталПрице = 100;
дозволити корисничко име = "Јован";Побољшана читљивост кода може се постићи коришћењем описних имена променљивих
2. Именовање Боолеан
Променљиве које могу имати само две вредности, тј истина или лажно, познати су као Булови. Кључно је одабрати одговарајућа имена за логичке варијабле које изражавају њихову сврху.
За илустрацију, уместо да се одлучите за име променљиве као што је тачно је, требало би да радије идете са је важећа или хасВалуе.
Размотрите овај пример:
дозволити исВалид = истина;
дозволити хасВалуе = лажно;У овом примеру, дескриптивна логичка имена променљивих јасно показују шта представљају.
3. Функције именовања
Функција у ЈаваСцрипт-у се односи на самосталну јединицу кода која је намењена да изврши одређени задатак. То је блок кода који други делови кода могу позвати или позвати и који функционише као независна целина.
Да бисте ефикасно именовали функције, користите описна имена која преносе њихову сврху. На пример, уместо креирање функцијефоо, одлучите се за илустративније називе попут валидатеУсерИнпут или израчунајТоталПрице.
На пример:
функцијаизрачунајТоталПрице(цена, количина) {
повратак цена * количина;
}
функцијавалидатеУсерИнпут(улазни) {
повратак унос !== недефинисан && унесите !== нула;
}
4. Константе именовања
Константе су променљиве које се не могу поново доделити. Приликом именовања константи, важно је користити сва велика слова и доње црте за раздвајање речи.
На пример:
конст МАКС_ПРИЦЕ = 1000;
конст МИН_ПРИЦЕ = 0;У овом примеру, сва велика слова и доње црте су коришћена за раздвајање речи у називима константи.
5. Именовање класа
У ЈаваСцрипт-у, објекти се могу креирати користећи нацрте који се називају класе. Да би се постигле беспрекорне праксе именовања, од највеће је важности да се изврши ПасцалЦасе, конвенција о именовању која налаже велико слово првог слова сваке речи.
Узмите, на пример:
класаКолица за куповину{
конструктор(марка, модел) {
ово.маке = направити;
ово.модел = модел;
}
}
У овом примеру, класа Колица за куповину је именован помоћу ПасцалЦасе-а, што значи да је прво слово сваке речи у називу класе велико и да нема размака или доњих црта између речи.
6. Именовање компоненти
Компоненте су основни градивни блокови у савременом развоју софтвера, посебно у оквири као што је Реацт, који наглашавају код за вишекратну употребу.
Разбијањем сложеног корисничког интерфејса или апликације на мање делове којима се може управљати, можете креирати компоненте које се могу поново користити у различитим пројектима, смањујући време развоја и повећавајући код ефикасност.
Опет, топло препоручујемо коришћење ПасцалЦасе конвенције именовања за именовање компоненти. То значи да се прво слово сваке речи у имену компоненте пише великим словом.
Таква конвенција вам помаже да разликујете компоненте од других сегмената кода, поједностављујући идентификацију и манипулацију.
функцијаДугме(реквизити) {
повратак<дугме>{пропс.лабел}дугме>;
}У овом примеру, ПасцалЦасе конвенција о именовању је коришћена за именовање компоненте Дугме.
7. Методе именовања
Приликом именовања метода, кључно је користити дескриптивна имена која успешно комуницирају шта метода постиже пошто су методе функције које се односе на објекат.
На пример:
класаАуто{
конструктор(марка, модел) {
ово.маке = направити;
ово.модел = модел;
}
стартЕнгине() {
// код за покретање мотора
}
стопЕнгине() {
// код за заустављање мотора
}
}
}
Описна имена (стартЕнгине, стопЕнгине) се користе за методе у овом примеру, обезбеђујући да се њихова сврха лако разуме.
8. Именовање приватних функција
Функције дефинисане као приватне су ограничене на приступ само унутар објекта где су дефинисане. Од кључног је значаја додати почетну доњу црту (_) да бисте назначили да су функције приватне.
Ево примера:
класаАуто{
конструктор(марка, модел) {
ово.маке = направити;
ово.модел = модел;
}
_стартЕнгине() {
// код за покретање мотора
}
_стопЕнгине() {
// код за заустављање мотора
}
}
Коришћењем водеће доње црте у овом примеру, указује се да су функције приватне.
9. Именовање глобалних променљивих
Променљивама које су класификоване као глобалне може се приступити из било ког дела базе кода. Приликом именовања таквих глобалних променљивих, кључно је користити јасна и дескриптивна имена која ефикасно преносе њихову намену.
На пример:
конст МАКС_ПРИЦЕ = 1000;
конст МИН_ПРИЦЕ = 0;
функцијацхецкПрице(Цена) {
ако (цена > МАКС_ПРИЦЕ) {
// код за управљање високим ценама
} другоако (цена < МИН_ПРИЦЕ) {
// код за управљање ниским ценама
}
}
10. Именовање датотека
Ефикасна организација датотека је кључни аспект успешног управљања ЈаваСцрипт пројектима. Да бисте обезбедили поједностављене и доследне конвенције о именовању, неопходно је одвојити речи у називима датотека користећи мала слова и цртице.
Пожељна су мала слова јер је ЈаваСцрипт језик који разликује велика и мала слова, што значи да језик различито третира мала и велика слова. Коришћење малих слова за називе датотека обезбеђује доследност и избегава забуну приликом референцирања датотека у коду.
Цртице се користе за раздвајање речи у називима датотека јер размаци нису дозвољени у називима датотека. Могу се користити и друге алтернативе као што су доње црте или цамелЦасе, али цртице су генерално пожељније због њихове читљивости.
Коришћење цртица такође чини имена датотека доступнијима за кориснике са читачима екрана или другим помоћним технологијама.
моја-апликација/
├── срц/
├── компоненте/
├── буттон.јс
├── поље за унос.јс
├── утилс/
├── стринг-утилс.јс
├── дате-утилс.јс
├── апп.јс
├── индек.јсУ овом примеру, мала слова и цртице се користе за раздвајање речи у називима датотека.
Важност поштовања конвенција о именовању у ЈаваСцрипт-у
Праћење добрих конвенција о именовању је суштински аспект писања чистог кода који се може одржавати у ЈаваСцрипт-у. Пратећи ове конвенције, можете учинити свој код читљивијим и одржаванијим, посебно у неким случајевима ЈаваСцрипт оквири у којима се од вас тражи да рукујете гломазним кодом, што вам може уштедети време и труд у на дуге стазе.
