JavaScript API開発の優れた方法

Question

JavaScript APIを設計するには、どのような方法が良いでしょうか？

私は、JavaScriptの新機能であり、主に「JavaScript：The Good Parts」から、その言語の重要な機能を学んでいます。現在、統計を教えるためのWebベースのツールを設計しています。私はJavaScript APIを設計する方法を理解していないので、コードベースは部分的に扱いにくくなってきています。

私の背景はJavaとC++であり、これらのインターフェイスを個別に実装するのに慣れています。明らかに、これはJavaScriptではうまくいきません。

ご協力いただきありがとうございます。

更新：ここでは、ツールの最終バージョン：http://www.lock5stat.com/statkey/index.html

Answer 1

私の意見では、jQueryを使用している場合は、アプリケーションをjQueryプラグインとUIウィジェットに分割することをお勧めします。プラグインは、コードを整理するのに最適な方法です。他のアプリケーションで再利用することもできますし、個別にリリースすることもできます。

プラグインのツリーとしてアプリケーションを記述することができます。 C++/Javaのクラスのようなプラグインについては、継承ではなく継承で考えることができます。コードについて

注：あなたがのdocument.createElementを使用MAIN.bootstrapPlot機能で、あなたは残りのコードのようにjQueryを使用する必要があり、そしてキャンバスのためCanto libraryをご確認ください。

Answer 2

私は言語機能を念頭に置いて、言語に関係なく、任意のAPIを開発するなど、その同じだと思います。

1. あなたはなど、

2. ドキュメントをインタフェースはJavaScriptであまり意味がありませんが、それはオブジェクト指向である、あなたは「クラス」にあなたの機能を分割することができるように、デザインパターンを使用して指摘するように。任意のAPIを文書化するのと同じように、javascript 'クラス'をドキュメント化することができます。

3. jsのインターフェイスまたは抽象クラスのネイティブサポートはありませんが、依然として原則を適用できます。たとえば、エラーをスローするメソッドを持つオブジェクトを定義することによって '抽象クラス'を作成できます。そうすることで、サブクラスが正しく実装されていないとエラーになります。インタフェースを使用するものであれば、必要なメソッドがinit上にあるかどうかを簡単に確認できます。いくつかのjsの人々は、jsが緩く型付けされ、動的であることを指摘し、このように使用すべきであることを指摘しています。ジャバスクリプトのようなという概念がないので、私は引用符で「クラス」を入れ

注意。もう1つのことは、SenchaやjQueryのような既存のAPIを見ていくつかのアイデアを得ることです。 SenchaはAPIのように、サーバーサイドの開発者が（ドキュメントを見て）慣れていると感じています。

Answer 3

John Resig has a scathing critique of the NodeIterator API. 1つの特定のAPIのレビューですが、（少なくとも彼が信じている）優れたツールについてのいくつかの洞察を提供します。