I've recently started working on a pretty large project that has been around for about a year and a half. Unfortunately, there's no documentation available, and I'm struggling to understand this complex code with very specific method names. My plan is to trace the code from the endpoints down to the methods and the database, but given that there are hundreds of complicated functions, I'm not quite sure if that's the best approach. Any advice on how to effectively study such a codebase?
5 Answers
One effective way to get started is by grabbing some bugs to fix. It’ll help you trace how things work while you're resolving issues, giving you insights into the code. Plus, you'll be making progress by fixing real problems! That's how I started, and it helped a lot!
Sometimes the best way to learn is to take a risk and try changing a part of the code. If you think you understand a section, modify it, build it, and see if it works differently. If your changes break something, you'll gain clarity on how that piece functions!
Tracing the data flow from the endpoints to the database isn't a bad strategy. I suggest you document everything as you learn. You might want to check if your code's language has tools for generating call graphs, like Doxygen for C/C++. It can be super useful for visualizing interactions in the code. Just try to stay focused and organized while you learn it all!
Have you considered using AI tools to help analyze the code? Something like ChatGPT can offer insights and even help generate documentation—if your company permits it. It might be worth checking alternatives like Claude Code, which can also assist you with your local files.
It really depends on your personal style! You might find it helpful to track bugs systematically while charting the program's flow on a whiteboard. Focus on one area at a time, and see what techniques help you absorb the information better.
I can relate! I also began my journey by tackling lower-priority bugs when I joined my company. It forced me to explore the code, understand how it functioned, and I ended up learning a ton!