airbnb.io - Ruby Style Guide Airbnb's Ruby Style Guide2,366

Airbnb Engineering & Data Science

Airbnb.io Spined HTML

Airbnb Engineering & Data Science Airbnb.io Open SourceEventsBlogGithubCareersAirbnb.io Ruby Style GuideAirbnb's Ruby Style Guide2,366By Jason Katz-BrownThis is Airbnb's Ruby Style Guide. It was inspired by Github's guide and Bozhidar Batsov's guide. Table of Contents Whitespace Indentation Inline Newlines Line Length Commenting File/class-level comments Function comments Block and inline comments Punctuation, spelling, and grammar TODO comments Commented-out lawmaking Methods Method definitions Method calls Conditional Expressions Conditional keywords Ternary operator Syntax Naming Classes Exceptions Collections Strings Regular Expressions Percent Literals Rails Specific Be Consistent Be Consistent If you're editing code, take a few minutes to squint at the lawmaking virtually you and determine its style. If they use spaces virtually all their arithmetic operators, you should too. If their comments have little boxes of hash marks virtually them, make your comments have little boxes of hash marks virtually them too. The point of having style guidelines is to have a worldwide vocabulary of coding so people can concentrate on what you're saying rather than on how you're saying it. We present global style rules here so people know the vocabulary, but local style is moreover important. If lawmaking you add to a file looks drastically variegated from the existing lawmaking virtually it, it throws readers out of their rhythm when they go to read it. Avoid this. — Google C++ Style GuideLinksGithub© Airbnb, Inc.© Airbnb, Inc.CareersDesignCareersDesignCareersDesign