問題タブ [jsduck]

イベントを処理するクラス (ExtJS サブクラスなど) のメソッドに配置するのに最適な種類の jsduck ヘッダーは何ですか? jsduck は jsdoc と同じタグをサポートしているようですが、@event タグが適切かどうかはわかりません。

JSDuckは、生成されたドキュメントでユーザーフィードバックを提供します。Senchaはこれをコードのダウメントに使用します。ブログ投稿で説明されています。

そのコメント機能を開発チームにも使用したいと思います。

誰がそれを行う方法を知っていますか？

私は JavaScript ドキュメント ツールを調査しており、JSDuck が印象的であることがわかりました。Appcelerator チタンもそれを使用していることに気付きました。しかし、Sencha の JavaScript フレームワークを使用しないコードを文書化するための使用に関する情報はあまり見つかりませんでした。Javascript コードの文書化にどのように、またどのように使用できるかについての提案はありますか?

例: 次のようないくつかの関数を含む .js ファイルがいくつかあります。

JsDuck.exe がヘルプ ファイルを作成した後、関数の説明に関数のパラメーターが存在せず、説明付きの値 bRes のみが返されます。バージョン: SDuck 5.0.0.beta2 も以前のバージョンで試してみましたが、同じ結果でした。

関数型フレームワークに JSduck を使用して成功した人はいますか。または、この作業を適切に行うための回避策はありますか?

同じ .js ファイルが JSDoc ツールキットで正しく機能し、すべてのデータが表示されますが、それでも機能させるには JSDuck の方が望ましいです。

返信ありがとうございます。

JS ライブラリのドキュメント ジェネレーターを探しています。私は、JSDuckが最も包括的で強力なものだと思います。しかし、その構文を使用してジェネリック クラスと関数の型変数を定義する方法がわかりません。よく使われている JS ドキュメント ジェネレーターをざっと見てみると、どちらもそれを行う能力を持っていないように感じます。ここに私が探しているものの疑似例があります:

出力例:

MyArray<T>
私の完璧な配列クラス。

BirdArray<T extends Bird > extends MyArray <T>
このすばらしい配列クラスを使って鳥を数えてください。

JSDuck でそれを達成する方法はありますか? そうでない場合、私のためにそれを行うことができるJSドキュメントジェネレーターはありますか? 任意のクラス継承パターンを使用できることを確認するために、JSDuck と同じくらい汎用性があると想定してください。

JsDuck でドキュメントを生成しました。私が気づいたことの1つは、オンラインドキュメントで見たにもかかわらず、ガイドの印刷ボタンがないことでしたか?

ドキュメントをビルドするときに構成ファイルで有効にするにはどうすればよいですか? 利用できない場合、印刷可能なバージョンを取得するには、どのように URL をフォーマットすればよいですか?

印刷可能なバージョンの例は次のとおりです

http://docs.sencha.com/extjs/4.0.7/?print=/api/Ext.ComponentQuery#

同じhttp://localhost:50005/?print=/api/SLMS.db.Functionsページをロードしただけです。

私は、JSDuck でドキュメントを生成するために十分に注釈が付けられた JavaScript ライブラリを持っています。私のライブラリに適切な IntelliSense を提供するには、このような注釈で十分だと思います。また、JSDuck 構文は、一般的な Google Closure Compiler 構文の拡張として設計されているため、かなり標準的です。しかし、コード注釈を使用して IntelliSense を提供する IDE はないようです。変数の型を提案しようとする「スマート」エンジンはたくさんありますが、注釈を読み取ってライブラリがどのクラスを持っているかを判断する「堅固な」エンジンはありません。

役に立つ場合は、私のライブラリとJSDuck によって生成されたドキュメントへのリンクを次に示します。

Visual Studio で js メソッドのコメント スタブを生成したいと考えています。

「JScript vsdoc Stub Generator」と呼ばれるコメント スタブ ジェネレーターがありますhttp://visualstudiogallery.msdn.microsoft.com/e122a031-d748-41e9-87b1-7b56d8610d8b

しかし、JsDuck を使用してドキュメントを生成したいと考えています。

したがって、jsDuck を使用するには、次のようにコメントする必要があります。

これを行うためのビジュアルスタジオの拡張機能を知っている人はいますか?

Solaris で JSDuck v5.3.4 を実行しています。単一の非常に単純な入力ファイルを使用します。

そして、私はそれを次のように実行します：

生成されたコンテンツを参照しようとすると、大きな読み込みギアと緑色の JSDuck バナーが表示されますが、決して終了しません。Chrome インスペクタ コンソールに JS エラーが表示されます。

スタンドアロンの Win32 JSDuck 実行可能ファイル (v5.3.4 も) を使用して、このドキュメントを Windows で問題なく生成できます。

私が間違っているかもしれないことを理解するのに助けていただければ幸いです! 生成された出力にソース マップはありません。また、Ext4 のバンドル バージョンの縮小またはソース マップを無効にする方法も見つかりません。これが最も一般的な JS エラーであることを考えると、この「Uncaught TypeError: ...」の検索は実りがありません。