Поддържането на код е по-сложно от писането му. Преди да направите каквито и да било промени, трябва да разберете какво вече има, как е трябвало да работи и как работи сега. Трудността на тази задача ще зависи от това как е структуриран кодът и дали е лесен за четене. В тази статия ще ви покажа как можете да направите кода си по-четлив и следователно по-лесен за поддръжка.
Очевидни входни точки
Когато стартирате тикет в приложение, обикновено имате някаква информация за това къде трябва да се случи промяната или корекцията. Можете да улесните свързването на това място с кода, ако последователно използвате някаква конвенция за именуване и поставяне на файловете. Нека да разгледаме няколко примера.
Приложение, базирано на компоненти
В ежедневната си работа създавам и поддържам няколко Angular приложения, които са изградени с компоненти. Всяко приложение има много дефинирани маршрути и за всеки маршрут има компонент от най-високо ниво, който отговаря за този изглед. Конвенцията за именуване, която използваме, е следната:
- прост маршрут:
/home-page—<home-page> - вложен маршрут:
/long/nested-route—<long-nested-route> - маршрут с параметър:
/user/:id/edit—<user-edit>
По този начин, ако получа маршрута, където трябва да се случат промените, мога веднага да намеря свързани файлове с компоненти.
Бекенд
В задната част имаме няколко ограничения, поставени върху маршрутите, които използваме. API е вдъхновен от подхода REST и всяка крайна точка е свързана с една от колекциите, които имаме в базата данни. Маршрутите са във формат /collection/operation - например:
/users/get/transactions/get-report
Кодът, който се извиква от тези крайни точки, е организиран във файлове от колекция: така че в един файл имаме методи, свързани с колекцията на потребителите, а в друг имаме методи, свързани с транзакциите. По този начин, въз основа на първата част от API маршрута, знам къде да търся кода.
Избягвайте ненужните скокове
Един от начините, които често виждам, прави кода сложен, е като изпраща читателя през много ненужни скокове...
