Writing Maintainable JavaScript

http://channel9.msdn.com/events/mix/mix11/EXT23

by rmurphey3 • 15 years ago

68 19 15 years ago

channel9.msdn.com

autalpha3• 15 years ago

I refuse to install Silverlight :P

rmurphey3• 15 years ago

It's just a video tag for me in Chrome.

ChiperSoft2• 15 years ago

Shows up as an HTML5 video element for me in Safari.

emehrkay• 15 years ago

Forced me to install silverlight; safari windows (work machine so I dont care)

PetrolMan• 15 years ago

You should have to work with it...

autalpha3• 15 years ago

"Doh! Your browser doesn't seem to support Silverlight or HTML5 video or we don't have an HTML5 video for this one."

that's what I get when I clicked play. I'm using FF4 on Mac OSX.

hasenj• 15 years ago

Works in Chrome without Silverlight, but not in Firefox.

wccrawford• 15 years ago

These apply to all languages, not just Javascript. It's pretty basic techniques for keeping your code nice:

Decouple/Blackbox

Naming Conventions

Start using these techniques now, refactor old code over time

mberning• 15 years ago

Write as little code as possible. The easiest code to maintain is the code you never had to write.

cema• 15 years ago

Partially true. Short code may be too cryptic to be easily maintained.

IgorPartola• 15 years ago

Write neat code. Not clever, not verbose. Neat.

Also, write code which calls only really well documented functions. Doing jQuery("#my-input").val() is clear enough. Doing myCrazyFramework.dom.manuplators.find.get_value('my-input') is more obscure, even though it's more verbose.

Write code that's been written before. Don't use clever patterns you found on code snippet sharing websites (http://code.activestate.com/recipes/66531-singleton-we-dont-... for example). Keep using the same pattern over and over.

Write small chunks of code: a function over 50 lines is probably really hard to read. This is a rule of thumb, not a commandment, but I found it to be true in at least > 51% of cases.

Avoid code magic. E.g.: deleteUsers(username) should not check for whether username has the substring "test" in it to see if the user should really be deleted.

Avoid state at all cost.

Avoid timing dependence. Pretend like anything in your application can happen any time any place.

Handle all exceptions.

I'm probably wrong on at least 50% of the above, and am probably missing 10 time as much...

ChiperSoft2• 15 years ago

My god, he is so hungover in this video...

clocktower• 15 years ago

Not hungover; just _really_ tired. I want to have a talk with whomever scheduled me for a 9am slot. Also, the light was in my eyes whenever I tried to look out toward the audience. AND OTHER EXCUSES, TOO

euroclydon• 15 years ago

Straight up question: How do you build source code documentation?

I use jsDoc (closure compiler's version, with data annotations). Because of this, I can't wrap all my code in a closure, which seems so popular these days. jsDoc won't parse through the closure. So, I use namespaces, and keep all my code in the global scope. It works great.

diamondhead• 15 years ago

see the irony

kragen• 15 years ago

Is there a non-video version of this?

Todd• 15 years ago

Thanks for posting. I meant to go to this session but it was too early.

Writing Maintainable JavaScript

Related Stories