Code is code… right?
A couple of weeks ago I had a look at my wife’s Phd. project on GitHub. It’s a mix of Python, C and C++ code, all written by people of the TU Delft phyisics department. Looking at the project I found it hard to understand some of code and asked her:
What does the variable
Ado? Why is is named
She wanted to know what
A and what line I meant, so I told her:
A = 5 * E_BZ
Oooooh, you mean the capital letter
A! We named it
Abecause that’s the name we gave it in the paper.
This style of code is perfectly fine for academics, but would never pass a real-life code review at @OGD-software. In this series of posts I’ll have a look at university projects on GitHub and refactor some of the code to highlight the differences between our code styles.
C project first and evaluate other languages/projects later.