Tips for making code as readable as possible?


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 this keyword
  • 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.

Submitted July 17, 2017 at 05:04AM by zayelion
via reddit http://ift.tt/2t541GJ

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s