javascriptライブラリの依存関係を文書化するためのベストプラクティス

Question

jQueryといくつかのプラグイン、またはMooTools、またはもっと難解なライブラリが必要な、外部の.jsファイルに一連のコードを作成しています。明らかに、実際の「インクルード」は、各スクリプトにロードするときにHEADセクションのホストHTMLページで行われます。

しかし、移植性のベストプラクティスとして、JavaScriptの.jsファイルにはどのような組み込み機能や広く採用されている規則が存在し、コードを使用する次のschmoeが他の必要なライブラリも含むことを忘れないようにします。

私は開発者コミュニティからいくつかのコンセンサスを探していますので、最も一般的に思われる、またはあなたが最もよく知っている答えに投票してください。

Answer 1

jQueryのUIは、ファイルヘッダに自分のウィジェットの依存関係を追加します。今、残念ながらJavaScriptの依存関係の管理者は、彼らが必要以上の方法以下で使用されている

/* 
* jQuery UI Effects Bounce @VERSION 
* 
* Copyright 2011, AUTHORS.txt (http://jqueryui.com/about) 
* Dual licensed under the MIT or GPL Version 2 licenses. 
* http://jquery.org/license 
* 
* http://docs.jquery.com/UI/Effects/Bounce 
* 
* Depends: 
* jquery.effects.core.js 
*/ 

が、あなたはあなたのライブラリを作ることができれば、ユーザーは1あなたがwouldnに切り替え「Tは、すべてのことを心配する必要があります。

• StealJS
• Jingo
• YUI loader
• Pyramid Dependency Manager

特定のプラグインがあるか、例えば（利用できない場合は、動的に反応することができるので、明示的に、あまりにも、良い考えかもしれませんチェックjQueryのUIダイアログが見つからないか、または単に正常に低下し、シンプルなモーダルウィンドウが表示されていない場合）例外をスローし、次のいずれか

if(!$.isFunction($.fn.dialog)) { 
    throw "Could not find jQueryUI dialog. Please include jQuery UI"; 
} 

スクリプトは、オプションの依存性がない場合は、完全に壊れていなくてもその方法会ったそこのVisual Studio開発者にとって

Answer 2

私のJSヘッダは次のようになります。

//////////////////////////////////////////////////////////////////////////////// 
// 
// src:  www.someDomain.com/js/modules/etc 
// author:  someguy 
// date:  6-22-11 
// intent:  what is the purpose/use of this module 
// package: prototype parent 
// requires: jquery.1.4.js 
//    fancybox 
//    etc 
// 
//////////////////////////////////////////////////////////////////////////////// 

どれ依存関係はその後、私のチームの誰にも非常に明確であり、これはかなり信頼性が実証されています。 （うまくいけば）二次対策として、私は常に実行時にこれらの依存関係をテストし、スクリプトが含まれていなければ警告を投げます。

Answer 3

これはあなたの依存関係を解決しませんが、あなたのヘッダ

/// <reference path="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.6-vsdoc.js" /> 
/// <reference path="thirdparty/ba-debug.js" /> 
/// <reference path="thirdparty/underscore.js" /> 

にこれらのようなブロックを試してみたいことがあり、それはそれらを文書化し、それがビジュアルでインテリセンスあなたを与えますメーカー...

は

（...申し訳ありませんが、に直接リンクしていない 名か ID）、その後 参照ディレクティブを探し、http://msdn.microsoft.com/en-us/library/bb385682.aspxを参照してください。

Answer 4

ソフトウェアエンジニアは常に、自分が何をしているのかを知っておくか、少なくとも思い出してください。彼らは、依存関係のリストを単独で保持し、なぜそれらが必要なのかを非常に明確にすべきです。とにかくページに含めるjsファイルはあまりありません。

ブラウザにjQueryとプラグインがあるといいと思うので、トラフィックを節約するためにページに含める必要はありません。