benchflow / data-transformers

Spark scripts utilised to transform data to the BenchFlow internal formats
Other
0 stars 0 forks source link

Properly Comment the Code #83

Closed VincenzoFerme closed 7 years ago

VincenzoFerme commented 7 years ago

Comment all the choices in the code for which a comment might help to understand the why. Although it is tricky to decide what comment and what not to comment, a suggestion can be to comment all the code that after a couple of day you wrote need more than 5 seconds to grasp what the code is doing. For sure algorithms must be commented and documented in the most important steps.