Coding like Shakespeare: practical function naming conventions

https://rainsoft.io/coding-like-shakespeare-practical-function-naming-conventions/

by panzerdp • 10 years ago

87 29 10 years ago

Code is prose, maybe, but there are definitely lots of different types of prose, and I don't think code would be one of the types of prose that has protagonists, comedic characters, and damned villains (or if it is, it should not strive to be so). In other words please this recurring code is like great literature kick is really irritating.

maybe one off scripts should be like lyric poetry though.

yolesaber• 10 years ago

https://en.wikipedia.org/wiki/Shakespeare_Programming_Langua...

delinka• 10 years ago

"The method name getAbsoluteDifference() means to get the absolute difference between the pair of numbers. The method name contains a verb get. It would not make much sense to name the method simply absoluteDifference(), because such name does not indicate any action."

I disagree. I want the property of 'absolute difference' between the two numbers. Getting that value is what I do when I make an assignment. Whether this value is cached or calculated is of little consequence to outside code provided it has no side effects on other state within the object. Should a method (member function, whatever) cause side effects within the target object, then the method has become a verb. Like, 'increase(by:)' - that's a verb, affects the state of the object ... well-named, friend.

Aside from that, I think the rest has embodied well Apple's talk about Swift API style from WWDC with a nice dose of input from this author.

Edited to add: 'getAverage()' shows up later. I fail to see how 'get' adds anything of importance considering its company 'reversed' and 'sorted' - they should all prefix with 'get' or they should not. I'm in the 'not' camp.

function_seven2• 10 years ago

It would make me sad to type getSqrt(), getMin(), getMax(), getStrLen(), getSizeOf(), get…

Putting a verb in the function name is not a bad idea, but if you find yourself identifying the verb as “get”, then it’s a useless three extra letters.

TillE• 10 years ago

I think for most people, "getFoo" generally implies direct access to a data member, not a calculation. This is a useful hint, and an argument for not using it in other contexts.

Stratoscope• 10 years ago

Back in the early days of Pascal programming for both DOS and Mac, it was common to put a 'the' prefix on just about every variable. I guess it was supposed to be more "English-like". You'd have variables like this:

  theWindow
  theUser
  theFile
  theLineCount

I hated it! I never did find out why people wanted to put in such a useless noise word in every single variable name, but I decided to never do it again.

Make every word count.

viraptor• 10 years ago

It's interesting how functions and properties can change the appearance. I like .xyz or .getXyz() - but the other way around it just seems wrong.

Terr_• 10 years ago

I'm in the "do" camp, because using "get" (or similar verbs) offers a hint that the method does not mutate the object.

"Average" can be both a noun and a verb, so "getAverage()" clarifies that it's being used as a noun.

An alternate but less-common approach would be to assume verbs and conjugate, like "averaged()"... But what if the verb and noun have very different meanings?

partycoder2• 10 years ago

I think a lot of this can be generalized as:

- Don't force people to guess. Guessing takes time, and is an opportunity for a mistake.

- Explicit information is better than implicit information. Abbreviations, incomplete identifiers are a form of implicit information.

- Lying exists in programming. Identifiers that do not match their purpose can mislead programmers and introduce bugs. e.g: Including side-effects in a function is called "get", "read" or "retrieve".

- Coupling brings more information into a scope, making it more complex and decreasing readability.

slau• 10 years ago

This may not be a popular opinion, but for me read and retrieve are indicative of a side-effect. I consistently use retrieve to indicate fetching things from database, or remote locations (REST, RPC, whatever). Similarly, read, in the case of a parser or whatnot, indicates that the buffer will be advanced.

Maybe I'm just too biased because I try to have const-correct/mutable-correct code?

grzm• 10 years ago

Sounds like you're building up a set of conventions which can be very useful when you're consistent with them and communicate them to others reading your code.

clusmore• 10 years ago

Agreed, these words have similar connotations for me as well. I have also seen deliberate usage of set vs update to indicate changes to objects in memory only vs persistence to databases, etc.

partycoder2• 10 years ago

If it's a partial read that requires to track state, then yes. If it's a somehow self-contained read operation that returns a result, while it has side effects (I/O), it may not necessarily have to mutate variables in your program (e.g: load a small file into string variable, make a HTTP response and return the body, etc).

mannykannot• 10 years ago

The scope is to understand what the function does from its name, arguments list and the way it is invoked.

Good names mean a great deal, but this is too much to expect from them. Understanding what a function does includes issues such as its time complexity, whether it is thread safe, what (if anything) it modifies, what exceptions it might throw and what exception safety guarantees it honors... And there may well be specific corner cases - for example, in a function with 'find' in its name, what does it do if there are zero or multiple matches to the key being sought?

orthoganol2• 10 years ago

Intelligent naming may be the most underrated skill of high quality programmers, along with "simplicity".

My go-to example is the Tensorflow code base. It sounds intimidating, deep learning, etc., right? But take something like the Seq2Seq implementation, and marvel how elegant and readable the module is. Some part of that is due to the simplicity of "programmer happiness languages" like Python and Ruby (sorry Java, JavaScript), but it's also clear that the easy part for them was making it work, while the part that probably took most of their focus was engineering simplicity. To even be in that position means you're already really, really good.

I typically contrast this with another Seq2Seq implementation in another certain library (I won't call out anybody) done by a PhD student, that looks very intelligent, but with no focus on engineering simplicity or elegant naming, it is an exercise in frustration to get through.

ch4s3• 10 years ago

Here's a link for reference https://github.com/tensorflow/tensorflow/blob/master/tensorf....

It is very nice to read.

orthoganol2• 10 years ago

Likewise their example implementation of it: https://github.com/tensorflow/tensorflow/blob/master/tensorf...

sebastianconcpt• 10 years ago

There is good advice indeed. I'm so into this. Also is making me miss Smalltalk which is from where I've learned to code for readability http://sdmeta.gforge.inria.fr/FreeBooks/WithStyle/SmalltalkW...

wyager• 10 years ago

Every function is an action

I disagree! This is a bad mindset that gets dispelled when you use a language that distinguishes between functions and actions. Writing to a database is doing something; returning the second value of a tuple isn't. There's no good reason to put a verb in the function that takes a tuple and projects out its subcomponents. "first" or "firstOf" gets the point across more concisely.

ktRolster• 10 years ago

Code like Shakespeare, you say??

https://en.wikipedia.org/wiki/Shakespeare_Programming_Langua...

z3t4• 10 years ago

Use deck instead of list, card instead of item, etc.

"for each card in deck" is much better then "for each item in list" as card and deck gives much more information!

Coding like Shakespeare: practical function naming conventions

Related Stories