Reading code

As developers, we spend a lot of time learning to write code, while spending little to no time learning to read code. Meanwhile, we often spend more time reading code than actually writing it. Shouldn’t we be spending at least the same amount of time and effort improving this skill? Deliberate practice can help us get better at reading code. Learning how to better read and understand code, can in turn teach us what makes code readable. This might even help us to write code that is easier to read.

In this talk we will discuss the benefits of deliberately practicing reading code in a code reading club or session without an IDE, as well as common strategies to navigate a new codebase and familiarise ourselves with the code using the IDE.

Transcript

1. Reading Code ArnhemJUG - August 31st, 2023 https://maritvandijk.com/
2. Reading Code Introduction • We spend more time reading code than writing code
3. Reading Code Introduction "developers on average spend as much as 58% of their time comprehending existing source code" - Felienne Hermans, The Programmer's Brain
4. Reading Code Introduction We read code when: • onboarding to a new project • adding or changing functionality • fi xing bugs • doing code reviews • reading books, blogs, ... • etc.
5. Reading Code Introduction • We spend more time reading code than writing code • But we don't practice reading code explicitly (much)
6. Reading Code Introduction • What if we practice reading code explicitly?
7. Reading Code Introduction • Code Reading Club https://codereading.club/
8. Reading Code Introduction • Fragment of code (outside an IDE) • Structured exercises
9. Reading Code Introduction • So many insights!
10. Reading Code Introduction • But what about the IDE?
11. Reading Code Introduction • Di ff erent strategies / approaches for di ff erent tasks • With & without your IDE
12. Reading Code Agenda • The bigger picture • Understanding a codebase • and it's context • Down to the details • Find a place to start • Search • Navigate from there • Understanding a speci fi c piece of code • Hints from your IDE • Exercises for deliberate practice
13. Reading Code Introduction • Focus: • Reading to understand • Not to judge
14. Reading Code The bigger picture
15. Reading Code The bigger picture • Onboarding to a new team / code base
16. Reading Code The bigger picture • What does the code do?
17. Reading Code The bigger picture • What is the context?
18. Reading Code The bigger picture • Background knowledge • Business domain • Programming domain
19. Reading Code The bigger picture • Read the documentation! • Do some research
20. Reading Code The bigger picture Strategies: • Identify components • Identify relationships / dependencies • Gain background knowledge
21. Reading Code The bigger picture • Take notes!
22. Reading Code The bigger picture But fi rst: • Check out the code • See if you can build it
23. Demo time
24. Reading Code The bigger picture • Draw your own diagrams • Write down questions • Write down suggestions (maybe)
25. Reading Code The bigger picture Science: • Chunking
26. Reading Code Down to the details
27. Reading Code Down to the details • Find a starting point
28. Reading Code Down to the details • Search
29. Reading Code Down to the details • Navigate
30. Demo time
31. Reading Code Down to the details • Draw your own diagrams • Write down questions • Write down suggestions (maybe)
32. Reading Code Understanding a piece of code
34. Reading Code Understanding a piece of code • Exercises
35. Reading Code Understanding a piece of code • Your IDE can help!
36. Reading Code Understanding a piece of code • Structure
37. Reading Code Understanding a piece of code • Restructure
38. Reading Code Understanding a piece of code • Behavior
39. Reading Code Understanding a piece of code • Context
40. Demo time
41. Reading Code Next steps • What's next?
42. Reading code Slides & More https://maritvandijk.com/presentations/reading-code/