microsoft / agogosml

agogosml is a flexible data processing pipeline that addresses the common need for operationalizing ML models at scale
MIT License
33 stars 16 forks source link

Remove redundant code + add type checker #234

Closed c-w closed 5 years ago

c-w commented 5 years ago

This pull request contains several changes that will make maintenance of the project easier going forward:

All Submissions:

margaretmeehan commented 5 years ago

Many of the comments you removed are certainly redundant, though I think commenting code can be helpful for people trying to understand a code base. Would like to hear better practices for how we can comment well.

c-w commented 5 years ago

@margaretmeehan Here's a concise "styleguide" for comments that I've seen successful on many projects in the past: ncrcoe/java-for-small-teams/style/comments. Other authors (e.g. Robert Martin in Clean Code) say similar things but with more words. In general, I'd try to avoid comments as much as possible since they tend to drift from the code over time as they're often not updated when the code is changed. I've often seen higher level documentation (e.g. diagrams of how the code interacts or how the architecture maps to the code) be more valuable and require less maintenance effort over time.