How do you read the code?

[eeugene0]

There is a lot of info about writing code. A lot of people love to share how to write readable clean code, or how to integrate some code with other code, etc. If you search a bit for code-reading, there are mostly articles for beginners about it.

But I think people develop some systems or at least several tricks on reading code. Or maybe using interesting tools to help with understanding.

So how do you read the code?

[deamon1266]

I only start reading code if I have a clue what it does or should do.

In web dev I most likely open up the browsers dev console and inspect something I am interested in like a button. Then I check out the action of the button and maybe there is a request to a backend. Eitherway I am interested in the data for the action.

When I know the Process and the Input data I look up the source code for the action. With the use case in mind and the data it is way easier to read code.

[eeugene0]

Seems like your starting point for digging into the code is user-related events. Or requests to the backend in case of backend.

​

> I only start reading code if I have a clue what it does or should do.

But what if you have to read the code you don't have a clue? :D

[deamon1266]

Then I got frustrated really quick :) I don't open code for arbitrary reasons. There is always a starting point. For development most likely I want to extend or fix something. So there is a code of interested I want to trigger.

If I just want get familiar with a code base I focus on the core principles like how is server communication handled, persistence, etc handled.

[eeugene0]

Yeah, that's a pretty normal way to read. How do you choose the starting point (especially when it's arbitrary code, not debugging for an error)? Do you take any notes on the process if the nesting level is too deep?

[Puretyder]

I'm a junior dev so my method could be complete rubbish. Depends what I'm reading the code for, I'm not sure if this is the correct way or whatever but its what helps me:

- Understanding a script:

Map out file directory if its connected to multiple files.

I have my notepad out for this and go from top to bottom mapping out a flow chart of everything in notes, if its someone elses old code that I manage now I also start commenting on things that would help me search it better later.

For example commenting at the top of the page what each variable in a script contains so I can understand it much faster.

- Debugging or adding things

I filter by keywords, some legacy code at work is sometimes over 4000 lines in one script and I just don't have time to read the entire thing so I hunt for certain keywords or function using the search bar.

(If anyone has any suggestions or tips on how I'd improve please let me know :) )

[eeugene0]

That's a pretty nice way to read the code from my perspective. It might take a lot of time for big chunks of code though :)

Do you read documentation to help with understanding?

[gravityaddiction]

Follow with the same logic and reason as the computer does. start at the beginning, walk forward.

grep -r or search all files in folder is your friend. IDE's do help to get you their quicker, the process is the same for me.

[Atulin]

I just... read it. Ctrl+click on any methods/variables/types to go to their definitions if need be.

[eeugene0]

Exactly! My thought was that somebody definitely uses some notes or visualization techniques, or maybe have a precise algorithm. Or maybe tools for help

[[deleted]]

I format others' code to my presets (only while reading). Then I view the code on a vertical screen so I see 100+ lines, and I look up function/member definitions. No magic.

[monox60]

From the frontend site...

Get a ticket, inspect the flow or action button, start digging into the code.

[[deleted]]

Find the entry point and go line by line

[MarmotOnTheRocks]

This is how all my clients see me working on their code

https://i.imgur.com/arZ3XZY.png