Code that says why it does

November 9, 2012 Tagged: programming Comments (View) Code that says why it does A new developer joins a project, and asks in Campfire: “what is the purpose of the can_refer_other_users flag?” The flag in question is a boolean column on User. Rails automatically created a query method for this column, which is used like so: if can_refer_other_users? # allow user to refer end The new developer’s innocuous query reveals an important subtlety between code that describes its job, and code that makes its purpose clear. At first glance, a name like can_refer_other_users seems quite good. You’re reading it now without any context, and can probably guess exactly what it does. The problem is, there are no clues about why we wouldn’t let a user refer others. Since growth is good, it’s counter-intutive that we’d block it. Looking in the database, most users have it set to true, with a...

Full article: http://robots.thoughtbot.com/post/35347834335/code-that-s...

Tweets

@fauxparse » 26 Nov '12, 7am
I don’t do much Rails coding at the moment, but the @thoughtbot blog is still great: [link]
@JaniArvonen » 19 Nov '12, 6pm
"Strive to write code that makes clear the meanings behind its machinations." - [link]
@Konrad » 14 Nov '12, 8pm
@kathrinpassig Die @codePrincess hat daze letztens einen tollen Blogpost verlinkt: [link]
@ichilton » 14 Nov '12, 3pm
Code that says why it does - [link] /via @pootsbook
@pootsbook » 14 Nov '12, 3pm
@twith2sugars @xocs @byrichardpowell @ichilton @jamesmills even better if you can combine the two in code: [link]
@rafschmid » 14 Nov '12, 7am
Self explaning code: [link] - For all those who didnt want to listen to me yesterday...
@featureenvy » 13 Nov '12, 6pm
"Code that says why it does" Don't we have comments for that? ;) [link]
@Mikesdish » 13 Nov '12, 2pm
Code that say what it does: [link]
@toru_inoue » 13 Nov '12, 2pm
RT @netwillnet: コードには、「そのコードが何をするか」という情報だけでなく「そのコードの目的は何か」という情報を含めるのが重要という話／ちょう参考になった / “Code that says why it does” [link]
@netwillnet » 13 Nov '12, 1pm
コードには、「そのコードが何をするか」という情報だけでなく「そのコードの目的は何か」という情報を含めるのが重要という話／ちょう参考になった / “Code that says why it does” [link]
@mcolley73 » 13 Nov '12, 12am
RT @theprogrammer: Code that says why it does [link]
@codePrincess » 12 Nov '12, 8pm
getting better in coding, so change this: "Code that is clear about its job, but opaque about its purpose." [link] #coding
@jsilzer » 12 Nov '12, 5pm
Code that says why it does -- and not just what it does [link]
@carhartl » 12 Nov '12, 3pm
Valuable programming advice of the day: Write code that tells why, not what. [link]
@bigardone » 12 Nov '12, 10am
Código que dice lo que hace [link]
@oppliger » 12 Nov '12, 5am
RT @nerdfits: Good practical insight: [link] via @prismatic
@elentok » 12 Nov '12, 4am
RT @itayad: "Good developers are careful to create code that clearly tells you what it does, but the why is far more important." [link]
@deiser » 11 Nov '12, 7pm
RT @juanignaciosl: Ejemplo de refactorización sutil y elegante: Code that says why it does [link]
@juanignaciosl » 11 Nov '12, 6pm
Ejemplo de refactorización sutil y elegante: Code that says why it does [link]
@ischi » 11 Nov '12, 2pm
"Code that says why it does" naming is always hard but the benefits of clear naming are huge to make it worth it. [link]
@gardenontario » 11 Nov '12, 2pm
RT @sgmckenna: Code that says why it does [link] via @zite
@sgmckenna » 11 Nov '12, 1pm
Code that says why it does [link] via @zite
@sfsekaran » 11 Nov '12, 11am
Totally agree. I should pay attention to this more. RT @thoughtbot: Code that says why it does. [link]
@TobiasTalltorp » 10 Nov '12, 10pm
RT @kalasjocke: Code that says why it does [link]
@ieduardogf » 10 Nov '12, 9pm
Yes please, write code that says why it does [link]
@smeade » 10 Nov '12, 8pm
RT @assaf: "Good developers are careful to create code that clearly tells you what it does, but the why is far more important." [link]
@assaf » 10 Nov '12, 8pm
"Good developers are careful to create code that clearly tells you what it does, but the why is far more important." [link]
@crdant » 10 Nov '12, 8pm
"…an important subtlety between code that describes its job, and code that makes its purpose clear." [link]
@cangsam » 10 Nov '12, 3pm
Code that says why it does something [link]
@NOX_73 » 10 Nov '12, 9am
RT @AntonKalyaev: Code that says why it does [link]
@RubyReflector » 10 Nov '12, 9am
Top Ruby Article: Code that says why it does: [link]
@nerdfits » 10 Nov '12, 1am
Good practical insight: [link] via @prismatic
@13k_ » 09 Nov '12, 11pm
Declarative code, yes please. - Code that says why it does /read in @feedly [link]
@lsdr » 09 Nov '12, 10pm
RT @lucashungaro: Code that says why it does [link]
@treyconnell » 09 Nov '12, 9pm
RT @rjkaes: Code that says why it does [link] (via Instapaper)
@cedricdelalande » 09 Nov '12, 9pm
Code that says why it does [link] #AppNet
@stuliston » 09 Nov '12, 8pm
Tidy little blog: Code that says what it does [link]
@alisdair » 09 Nov '12, 7pm
Code that says why it does what it does. [link]
@pembleton » 09 Nov '12, 7pm
RT @r00k: Code that says why it does: [link]
@rjkaes » 09 Nov '12, 7pm
Code that says why it does [link] (via Instapaper)
@ischroedi » 09 Nov '12, 7pm
thoughtbot news: Code that says why it does: A new developer joins a project, and asks in C... [link] [link]
@DeveloperKitty » 09 Nov '12, 6pm
RT @thoughtbot: Code that says why it does. [link]
@r00k » 09 Nov '12, 6pm
Code that says why it does: [link]
@jhbabon » 09 Nov '12, 7pm
RT @thoughtbot: Code that says why it does. [link]
@denniskuczynski » 09 Nov '12, 7pm
RT @thoughtbot: Code that says why it does. [link]
@Mockra_ » 09 Nov '12, 7pm
RT @thoughtbot: Code that says why it does. [link]
@thoughtbot » 09 Nov '12, 6pm
Code that says why it does. [link]