Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Reading source code [closed]

If you read other people's source code, how do you approach the code? What patterns are you looking for (datatypes, loops, use of control flow, ... )? How long can you read other people's code without getting bored? What is the most exciting patterns that you have discovered so far?

like image 341
poseid Avatar asked Dec 13 '22 06:12

poseid


1 Answers

At first, I ignore the urge to change the code. Which is sometimes hard to do. But understanding first and change later saves yourself a lot of nasty "learning experiences."

Next if the format is bad, reformat. Use a code formatter if you have one. This is because you tend to look at the indentation and if that is bad, your understanding of the code is also questionable.

Then, if there are complex datastructures, I like to draw a little diagram. The challenge here is keep it as simple as possible. Large diagrams are fun on the wall, but most of the time, they are to cumbersome to look at. So it is wasted time.

If you finally understand what a piece of code does, write a comment. This is essential, because else you won't understand it the next time you are here.

The following step is to create unit tests. Now you can not only test the code, but you can also test your understanding of the code.

Last, if you understand it al and you know it can (and need to be) better, change it. But be sure to run the tests. Unless you are paid by each solved bug.

like image 116
Toon Krijthe Avatar answered Dec 23 '22 12:12

Toon Krijthe