問題タブ [vsdoc]

Google CDN を使用して jQuery ライブラリを取得している場合、VS 2010 で IntelliSense サポートを取得するために、コンパニオン Microsoft CDN VSDOC ファイルを参照するにはどうすればよいですか?

これまでのドキュメントでは、VSDOC ファイルをスクリプト ファイルと一緒に同じフォルダー (Web サイト内) に配置し、命名規則を順守するという指示に出くわしました。
例えば

しかし、私のファイルはディスク上にありません。 これらのファイルをダウンロードせずに、ネットワーク経由で IntelliSense を取得できますか?

Microsoft CDN の jQuery VS Doc の場所:
http://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.6.2-vsdoc.js

Google CDN からの JQuery (Google API キーは表示されていません):

JavaScript 用のコメント ドキュメント形式と、HTML ドキュメントを生成するこの形式用のプロセッサはありますか?

現在、開発時に IntelliSense ヘルプを提供するために VSDoc xml コメントを使用していますが、私が知っているように、そのようなコメント用のドキュメント ジェネレーターはありません。代わりに、私の質問は次のように聞こえるかもしれません: VSDoc コメントを JavaScript ファイルから HTML に変換するユーティリティはありますか?

昨日、プロジェクトのjQueryをMicrosoftのCDNに移動したので、ついにjQueryインテリセンスが復活しました。わーい！ただし、すべての.jsファイルに次のものを含める必要があるようです。

上記の参照を含む単一のjsファイルを使用して、次のようにすべてのjsファイルに単一の不変の参照を含めることをお勧めします。

アイデアは、stdafx.jsがjQuery参照を含むファイルになるということです。次に、バージョンを更新したり、参照を追加したりする場所は1つだけです。さっそくやってみましたが、うまくいかなかったようです。誰かがこれを実現する方法を見つけられますか？

jQuery 1.7.1 VSDoc をダウンロードする場所を持っている人はいますか?

また、それを機能させるにはどうすればよいですか？Ctr-Shift-J現在、次のものがあり、 Intellisense を更新しようとすると、VSDoc で大量のエラーが発生します。

VSDoc を VS 2008 で動作させるための Service Pack 1 と Patch の両方の更新プログラムがあります。

私が理解しているように、スクリプトを参照するだけで ( KB958502がインストールされていれば) jQuery の Intellisense を取得できるはずです(-vsdoc バージョンが並んでいる限り)。

これを配布するために CDN を使用したいのですが、単純に以下を追加します。

あいまいな警告を与える

警告 1 JScript IntelliSense の更新エラー: C:...\Temporary Internet Files\Content.IE5\4U5FWPZF\jquery-1.7.1-fds90 1 ..js: オブジェクトはこのプロパティまたはメソッドをサポートしていません @ 1352:1 c: \プロジェクト...\MyFile.aspx

推測では、キャッシュ内のファイル名がjquery-1.7.1-vsdoc.jsの形式ではないため、「不機嫌になっている」と思います。特に、行ってもエラーが同じままであるためです。ずっと：

これはまだ機能しません。

vsdoc Intellisense がリモートでホストされているファイルで機能しないのは、単純なケースですか?

単一の名前空間を利用するように JavaScript ライブラリをリファクタリング中です。約 200 のモジュールがあり、以前は jQuery プラグインとして、またはグローバル オブジェクト (悪い) に登録されていました。以前の調剤では、Intellisense を機能させるために、各モジュール (Intellisense が必要なモジュール) のモジュール参照を追加しました。

すべてのモジュールファイルの先頭に。

以前の調剤についてのすべては、欠陥があり、壊れやすく、エレガントではありませんでした.

新しい調剤でそれを修正したいと思っています。このリファクタリングの主な目標の 1 つは、新しい開発者がライブラリでの作業を簡単に開始できるようにすることであり、Intellisense は大きなメリットをもたらします。

現在、すべての *.js ファイルを単一の nameSpace-vsdoc.js ファイルに連結しています。すべてのクラスのすべてのメソッドは、vsdoc 構文を使用して文書化されています。すべてのモジュールは、単一の vsdoc 参照を使用します。これは問題なく動作しますが、扱いにくいです。Intellisense は以前よりも 300% よく機能しますが、まだ十分な精度ではありません。私のxmlドキュメントの多くが欠けており、少し複雑なオブジェクトでさえも返すメソッド/クラスにうまく再帰しません。

YUI Doc は、JsDoc 構文からドキュメントを作成する方法を提供しますが、それは Intellisense には役立ちません。深い魂のグーグルは、サードパーティのソリューションを明らかにすることに失敗しました.

よりインテリセンス インテリジェントな方法で VsDocs を生成するツールはありますか?

アップデート：

広範な検討、テスト、段階的なリファクタリングを経て、この jsFiddle のような基本的な名前空間ができました。

これにより、名前空間に必要なメソッドを登録する自己実行関数で疎結合モジュールを作成できます。すべてのモジュールは次で始まります。

VS 2010 ビルド イベントに添付した単純な Perl スクリプトを使用して、この vsdoc を生成します。

_first-vsdoc.js および _last-vsdoc.js ファイルは、コンテンツ全体を自己実行関数にラップします。次に、必要に応じて、結果の vsdoc を Closure Compiler、YUI Compressor、および Uglify に渡します。

このプロセスは以前よりもはるかにうまく機能しますが、まだ欠点がないわけではありません。

ゼロから始めて、NameSpace-vsdoc.js を参照する NewModule.js で、適切な Intellisense を取得します。

ただし、 NewModule.js を次のように定義する (およびコンパイルする) と:

次の場合、適切な Intellisense が得られません。

サブ名前空間でうまく機能するため、これは困惑しています。私はこれを行うことを余儀なくされています:

コンパイルすると、突然 (明らかに) Intellisense が期待どおりに動作します。

Intellisense は、jQuery の vsdoc (このプロセスを構築する際に私が詳しく調べたものです) を使用してチェーンされたメソッドで動作し、jQuery はy.x = y.x || new x()それを実現するためのトリックに頼りません。

構造的な観点から、jQuery の vsdoc と私自身の vsdoc の間に認識できる唯一の識別可能な違いは、jQuery が名前空間全体を同じクロージャー内にアセンブルすることです。名前空間と各モジュールは、個別のクロージャでラップされています。それに比べて、私の vsdoc は自己実行関数の長い文字列のように見えます。

クロージャー/モジュール パターンを放棄することに関連するリスクが多すぎます。また、仮説を単独でテストすることは困難です。ライブラリが小さい場合、Intellisense は適切に機能するため、何千もの "Javascript Intellisense Message: C:\\js\NameSpace-vsdoc.js(40:16) : Object required" エラーを生成できません。

アイデア？

Visual Studio のパッケージ コンソールを使用して、次を使用して jQuery をインストールします。

インストールパッケージjquery

対応するjQueryファイルにもVS docファイルをインストールするコマンドはありますか?

-intellisense.js完全な jQuery および jQuery Validation intellisense を Visual Studio に追加するためのファイルまたはファイルがあり-vsdoc.jsます。つまり、名前空間、関数、引数、戻り値、コメントなどです。

• アンダースコアにそんなものはありますか？ライブラリをファイルに追加することで基本的な IntelliSense を取得でき_references.jsますが、上記で詳しく説明した残りの部分についてはどうでしょうか。

• おそらく、現在利用可能なすべてのインテリセンス ファイルのリストがどこかにありますか? たとえば、Knockout、地図や地理位置情報などの Google API、RequireJS、Bootstrap などを取得できればすばらしいでしょう。

メソッド呼び出しで使用するオプション オブジェクトについて、Visual Studio で Intellisense サポートを取得したいと考えています。

キャッチオール オプション オブジェクトを使用して Javascript の関数呼び出しを構成するのが一般的です。たとえば、jquery の Ajax 呼び出しでは次を使用します。

settings は次のような単なるオブジェクトです。

これは暗黙的なオブジェクトですが、プロパティは特定のクラスに従います。通常、Intellisense/記述コードにとっては重要であるが、コードが機能するためには重要ではないこのようなものがある場合、これを -vsdoc.js ファイルに入れます。しかし、どうすれば Intellisense をこのオブジェクトに対応させることができるでしょうか?

Microsoftが提供しているので、例としてjquery-vsdoc.jsを見ましたが、役に立ちませんでした。ある場合は「オブジェクト」と入力するだけで、別の場合はまったく文書化しません。

たとえば、これを試してみました-fillTable.jsで：

また、fillTable-vsdoc.js では:

しかし、Intellisense で得られるのは、型が FillTableOptions であることだけです。その後、オブジェクトを作成すると、プロパティの選択中に Intellisense のヘルプが表示されません。

では、このようなオブジェクトのプロパティの Intellisense サポートを取得するにはどうすればよいでしょうか?

これを含むスクリプトretry.jsがあります。

明らかにボディがありますが、スクリプトにボディがあるかどうかに関係なく、この問題が発生するため、問題ではありません。

この関数が返すオブジェクトを文書化するために、補助的な-vsdoc.jsファイルretry-vsdoc.jsもあります。

奇妙なことに、-vsdoc.jsファイルを削除すると、Visual Studio 2012のIntellisenseはretry.jsで正常に機能します（もちろん、返される内容については実際のヘルプはありません）。-vsdoc.jsをそのままにしておくと、IntellisenseでretryAjax関数を使用できなくなります。パラメーターの入力中にIntellisense情報がオートコンプリートまたは表示されません。ただし、RetryAjaxDeferred関数はIntellisenseでアクティブになります。

明らかに、-vsdoc.jsファイル内の何かが、retry.jsのIntellisenseを何らかの形で破壊していますが、それ自体の内容が消えるのを防ぐのに十分な破壊はしていません。私は何が間違っているのですか？