DEV Community

How to Produce Readable Code

Jaff Parker on June 17, 2019

This is the first installment in a series of articles of indefinite length. Throughout the years of working in various teams and building one, I h...

Read full post

Vlastimil Pospichal • Jun 18 '19 • Edited

actions on objects: user.get(), user.add(), post.modify(), post.delete()

user = new User(id)
print database.get(user)

posts = new Posts()
print database.get(posts)

post = new Post(data)
database.update(post)

Jaff Parker • Jun 18 '19

Yeah, that works too! I prefer a more functional approach though, that's pretty much what I described :) this is more OOP.

But as long as you and any person who hasn't seen your code can read it, anything works!

Otto Martikainen • Jun 26 '19

I agree about use of English and naming things clearly, but having function that gets all posts just to filter one by author and modify it's title seems quite inefficient.

Also in last example variable posts is not actually defined and example before that posts is a function so posts.filter is also undefined.

I'm trying to say that details do matter in code.

Jaff Parker • Jun 27 '19

Oops, thanks for pointing that out, I fixed it :) I'm used to the editor showing me wrong references.

This example isn't real and was just written for demonstration of all principles mentioned. If it were a post about efficient code, I definitely wouldn't have done that 😃

Nikolić Stjepan • Jun 18 '19

Thanks for the useful tips and easy to understand examples. :)

Gabriel Fellone • Jun 17 '19

Great post, Jaff
Thanks! :)