Tips for making code as readable as possible?
I'm working on an open source project where the team is mostly all noobish or coming from other languages. Any tips for making the code bases as readable to young developers as possible? So far I've done the following.
- Favored functional programming techniques; few classes, practically no use of the
thiskeyword - JSDocs on everything, some with type definitions.
- ESLint rules.
- Any type of algorithms have inline comments explaining them
- functions that are called are in the files that called them. Code is easily read from github.
Posted Jul 16, 2017, 10:04 PM UTC
39