Как мне сказать, где поставить обновление в коде

Question

Моя работа почти полностью состоит в добавлении новых функций в устаревшую систему, созданную моим предшественником.

Новые функции не представляют особой проблемы, я могу скопировать несколько кодеров из системы и знать достаточно, чтобы знать, как их использовать.

Моя проблема с 565 классами, я никогда не знаю, куда должна идти моя новая функция, что она должна наследовать. Документация по архитектуре отсутствует, и до сих пор мне приходилось читать, читать и читать исходники, пока я не смогу отследить вызов функции и найти подходящее место для размещения своего кода.

Прочитав это зрелище, я понял, что работа над кодом других людей, подобным этому, является необходимым навыком для программиста, поэтому должны быть некоторые профессиональные приемы, которые я бы хорошо освоил.

Какие советы и хитрости есть при обновлении кода других программистов?

Программа представляет собой сервер с базой данных, графический интерфейс веб-сайта.

Answer 1

Используйте какой-нибудь инструмент визуализации, чтобы выяснить, какая у вас модель зависимости.Затем начните с добавления изменений в место с наименьшими побочными эффектами.Документ, где вы его добавили и почему.Напишите модульный тест и функциональный тест.Тогда попросите обзор вашей работы.Затем вы можете постепенно начать продвигать и дедуплицировать свой код.Некоторые среды разработки помогут вам найти дубликаты кода.Дубликаты подскажут вам, куда должен идти код.

Если используется Spring или какая-либо DI-структура, посмотрите на композиционную модель.Возможно, вам нужно извлечь свой код и некоторый другой код в четко названный, четко определенный компонент.

Answer 2

Обычно полезно обсудить кодовую базу с другими программистами. Если повезет, они все еще могут быть на связи с первоначальным разработчиком.

Документируйте как можно больше; записывание того, что вы узнали, поможет вам запомнить его и поможет в будущем - как для вас, так и для других разработчиков.

Одна вещь, которую я иногда делаю, когда сталкиваюсь с новой кодовой базой, это рисует простые UML-диаграммы того, что я нахожу. Я делаю это вручную, потому что это помогает мне лучше понимать вещи. Не нужно делать совершенно правильный UML или составлять графики всего; просто нарисуйте то, что вы пытаетесь понять, и посмотрите, поможет ли это вам понять, что происходит. (Конечно, если вы решите сделать эти диаграммы частью документации, вам следует убедиться, что они не являются двусмысленными)

Надеюсь, это поможет. Удачи в вашем проекте!

Answer 3

Три вещи должны помочь вам решить, куда должны пойти любые изменения.

• Хорошо разработанный код должен прояснить, куда идут изменения (или, по крайней мере, что нужно изменить).
• Опыт. Опыт программирования поможет выбрать, какая часть детали изменилась.
• Дружественные. Даже при том, что база кода велика, вы ознакомитесь с ней и поймете, куда должны перейти следующие изменения (или, по крайней мере, узнаете, с чего начать).