Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Try a little tenderness
Search
masylum
July 01, 2013
0
91
Try a little tenderness
masylum
July 01, 2013
Tweet
Share
More Decks by masylum
See All by masylum
IPFS
masylum
0
180
REST Clients Nordic APIs
masylum
3
210
REST clients
masylum
2
190
Building the best tech-team
masylum
4
200
I love async but I can't code like this
masylum
4
500
Featured
See All Featured
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
35
2.4k
Being A Developer After 40
akosma
90
590k
Large-scale JavaScript Application Architecture
addyosmani
512
110k
Side Projects
sachag
455
42k
Measuring & Analyzing Core Web Vitals
bluesmoon
7
510
Gamification - CAS2011
davidbonilla
81
5.4k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
45
7.5k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
130
19k
RailsConf 2023
tenderlove
30
1.1k
What’s in a name? Adding method to the madness
productmarketing
PRO
23
3.5k
Learning to Love Humans: Emotional Interface Design
aarron
273
40k
Testing 201, or: Great Expectations
jmmastey
43
7.6k
Transcript
Coding is a fucking mess, big programs are complex and
troublesome... follow Ottis advice and Try a little tenderness
Who am I?
Pau Ramon CTO at Teambox ! @masylum github.com/masylum
This talk is about good code style principles
Why caring about style?
Development is not the bottleneck, maintenance is
Code may be ugly, but is what you stare at
all day
Mind your API Expose only what you need
Mind your API var obj = {}; obj.pi = 3.14;
obj.circumference = function (r) { return num * this.pi; };
Mind your API var obj = {}; var pi =
3.14; obj.circumference = function (r) { return r * a; };
Be verbose Good naming
Be verbose function avg(xs) { var s = i =
0; var l = xs.length; for(; i < l; i++;){ s += parseInt(xs[i]); } return s / l; }
Be verbose function average(numbers) { var sum = i =
0; var length = numbers.length; for(; i < length; i++;){ sum += parseInt(numbers[i]); } return sum / length; }
Explicit over Implicit Magic is for magicians
Explicit over Implicit function Dog() { this.speed = 4; }
require(‘run’); var dog = new Dog(); dog.run();
Explicit over Implicit function Dog() { this.speed = 4; }
Dog.prototype.run = require(‘run’); var dog = new Dog(); dog.run();
Careful with DRY It creates dependencies
Careful with DRY function truncateName(el) { var attr = el.type
=== ‘user’ ? ‘fullName’ : ‘name’; return el[attr].substring(0, 40); }
Careful with DRY function truncate(string) { return string.substring(0, 40); }
truncate(user.fullName); truncate(project.name);
Lines of code syndrome The myth of less is more
Lines of code syndrome function isUrgent(id) { if (task =
Task.find(id) && task.urgent) return true; return false; }
Lines of code syndrome function isUrgent(id) { var task =
Task.find(id); if (task && task.urgent) { return true; } return false; }
Self explanatory code Avoid inline comments
Self explanatory code function removeUser(id) { // find user var
user = User.find(id); ... // remove tasks return user.tasks.remove(); }
Self explanatory code function removeUser(id) { var user = findUser(id);
return removeTasks(user); }
Write contracts Document your API
Write contracts // removes the user function removeUser(id) ...
Write contracts /** * Removes the user and all his
* assigned tasks * * @param {Number} id - user id * @return {Boolean} - did work? */ function removeUser(id) ...
Beware of nesting Flow control complexity
Beware of nesting function isComplete(task) { var comment = task.comment;
if (comment) if (comment.status === 3) return true; return task.isResolved(); }
Beware of nesting function isComplete(task) { var comment = task.comment;
if (comment) { return comment.isComplete(); } return task.isResolved(); }
Beware of nesting setTimeout(function () { setTimeout(function () { console.log(‘B’);
}, 10); }, 20);
Beware of nesting ! function secondMethod() { console.log(‘B’); } function
firstMethod() { setTimeout(secondMethod, 10); } setTimeout(firstMethod, 20);
Use tools They are better than you
Use tools • Have static analyzers to detect bad code
practices and syntax errors • Use tools that can provide metrics • Integrate your tools with your editor • Integrate your tools with your process
Use tools • Javascript: JSHint • Ruby: Cane, Rubocop •
IDE • SAAS: Codeclimate
Avoid broken windows With metrics and processes
Avoid broken windows • Before pushing: Git hooks • Before
merging a branch: Travis • Before deploying a release: Jenkins