この文書は、JavaScriptとHTML5を利用してエンタープライズWebアプリケーションを開発する際のベストプラクティスや推奨事項をまとめたものです。
本文書のアドバイスは実際に当社（Sencha）の社内で使われているものです。Senchaフレームワークの構築に使われているスタイルガイドではありますが、他のフレームワークを利用している開発チームであっても有用だと考えています。もちろん、Vanilla JavaScriptの場合（*）であっても変わりません。
*訳注 ... フレームワークを使わずにJavaScriptのコードを書くことをVanilla JavaScriptと呼びます。
高品質なJavaScriptは何よりも一貫性があり、次の4つの柱によって支えられているものであると固く信じています。
- 可読性: 明確で、一目で理解できること
- 保守性: 一貫性があり、まとまっていること
- 例外の回避: よくある問題を戦略的に避けていること
- パフォーマンス: 常により速い実装を考慮していること
このスタイルガイドは、JavaScriptとHTML5を利用してエンタープライズWebアプリケーションを構築するための、いくつかの基本原則を提供します。そして、主に中規模から大規模の開発チームを想定しています。
本文書の推奨は私たち自身の経験だけでなく、当社のお客様との対話も元にしています。
このスタイルガイドについて、必要以上に気にし過ぎないようにして下さい -- この文書は単なるガイドで、絶対に守らなければならない教義ではありません。
本ガイドは「ベストプラクティス」についての網羅的な一覧を目指していません。それよりも、皆さんがよく私たちに質問される関心事について答えようとしています。 それらについては、他の多くの方も 似たような文書 を既に作成されており、全体で明らかな同意が取れていないトピックかと存じます。
この文書の全体的な目標は、コードの「品質」について私たちが重要だと考えている事柄をあなたが検討する手助けを行うことです。そして最終的には、あなたが読みやすく、保守しやすく、拡張性の高いプロジェクトを作成することを目指しています。 私たちの提案は、高品質なJavaScriptのコードベースを構築する戦略を組み立てる際の、開発チームが考慮すべきベースラインだと考えて頂ければ幸いです。
当社でのフレームワークとエンタープライズ・アプリケーションを構築した経験から、この議論については、次の4つの部分に分割させて頂きます。
これら以上に多くの内容についてカバーすることは、あまり価値がないと思われます。