次のドキュメントは、JavaScript と HTML5 で企業アプリケーションを構築するためのベストプラクティスと推奨される手法を記述しています。
これらのアドバイスの多くは、Sencha 内部で使われ、実際に Sencha フレームワークでアプリケーションを構築するときにも適用されています。 しかし、この JavaScript スタイルガイドは、他のフレームワークや、素の JavaScript を作る際にも役に立つことでしょう。
高品質な JavaScript というものは、とりわけて首尾一貫していて、次の四つの柱に取り組んでいると Sencha は固く信じています。
- 読みやすさ: JavaScript コードはクリアで簡単に一目見て簡単に理解できなければなりません
- 保守性: JavaScript コードは首尾一貫しまとまっていなければなりません
- エラー回避: JavaScript コードは、よくある問題を戦略的に避けなければなりません
- パフォーマンス: JavaScript コードは常に細則の実装を心がけねばなりません
このスタイルガイドは、企業ウェブアプリケーションを JavaScript と HTML5 で構築する際のいくつかの基礎ルールを提供します。主に中規模から大規模の開発チームを対象とします。
これらの推奨される手法は、我々自身の経験や、我々の企業顧客との直接のやりとりをベースにしています。
コードスタイルに取り付かれないようにしましょう -- このドキュメントは単なるガイドです、犯すべからざる教義ではありません。 このガイドは全ての「ベストプラクティス」を網羅したリストを目材してるわけではなく、我々に質問される事の中でもっともよくある部分のリストです。 同様な文書が他にも沢山ありますし、全ての人が全ての点で同意するわけがありません。
この文書の最終的な目的は、 あなたに我々が「高品質な」コードにとって何が重要な側面であるかについての我々の考えを評価してもらい、最終的にあなた自身の読みやすく、保守性が高く、スケーラブルな JavaScript プロジェクトをつくることです。 我々の提案は、あなたのチームが高品質な JavaScript コードベースを構築するための自身の戦略を実行するベースラインとして、という立場をとります。
フレームワークと企業アプリケーションを構築しているSenchaの経験を最も明瞭に表現するために、我々はこの議論を4つのパーツに分けます。
それは、我々がカバーするポイントの多くがこれらの柱の一つ以上に適合するかもしれない点に注意する価値があります。