問題タブ [jsdoc]

jsdoc を使用してコンストラクターの 2 つの署名を定義する方法を知りたいです。

これにより、{string} p1 を持つ 1 つのコンストラクターが生成されます。

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

メソッドを提供するjQueryの$.widget()基本「クラス」を使用しています。option()メソッドが私のコードにないので、引数を文書化する場所がありません。

デフォルトのオプションリテラルのフィールドにjsDocを配置しようとしましたが、それらは単に選択されていません。@class次に、同じオブジェクトリテラルでタグとタグを使用しようとしまし@lendsたが、オブジェクトリテラルは実際にはクラスではないため、これはかなり混乱する可能性があります。

私が実験したもう1つの方法は@param options.field description、コンストラクターのjsDocに次のようなものを入れることです。ただし、これには、ドキュメントをコードから分離するという欠点があります。optionsまた、コンストラクターには、すべてjQueryによって処理されるため、実際には呼び出される引数はありません。

Javascriptの達人はこれをどのように処理しますか？新しいタグを提案する必要がありますか？

私は次のようなものを持っています:

何か不足していますか？NSに上がります。-> オートコンプリート: MyAwesomeObject ですが、NS.MyAwesomeObject が必要です。-> オートコンプリート: 初期化(id)。

Class.create() を使用しない場合、他のケースでは問題なく動作します。私はググって解決策は@classを追加することでしたが、それはうまくいきませんでした。

ありがとう！

私は現在、個人のjavascriptモジュールに型注釈を追加していますが、正規表現をパラメーターとして関数を入力しようとすると、現在スタックしていますが、次の試行はどれも機能していません：

私は取得しているだけです：

宣言ではどのタイプを使用する必要がありますか？ありがとう。

Google Apps スクリプトを使用してツールセットを構築することを検討していました。これに関する問題は、私が知る限り、1 つのレベルの組織しか許可されないことです。Stopwatch という名前のライブラリを作成し、メソッド Stopwatch.start() および Stopwatch.stop() を呼び出すことができます。これはかなりクールです。

私が念頭に置いていたのは、Utils.Stopwatch().start() や Utils.Timer.start() などのようなものでした。JavaScript では確かに可能だと思いますが、Apps Script のオートコンプリート機能を壊し続けるには、特定の形式で追加されます。以下は、間違った方法の例です (エラーが発生します) が、おそらく時間を節約できます。この記事に基づいています。

ありがとう

私はJohn Resig の Simple JavaScript Inhertance@lendsを使用してクラスを定義し、それらを JSDocと注釈で文書化して@constructsいますが、NetBeans はコード補完を提供していません。これは、名前空間を使用して定義したモジュールで機能します。これは、それらを直接参照しているためです。単純なクラスの例を次に示します。

NetBeans でコード補完が利用できるように、これらのクラスを文書化する方法を知っている人はいますか?

私はまだjsを学び、Webstorm IDEを試しています。これはすばらしいようです（var / function宣言へのジャンプを含む）。

jsdocコメントのテンプレートを表示する方法はわかりますが、経験がなく、コメントで詳細を提供する方法とその詳細を表示する方法の例を探しています。

I'm writing my own library for the project at work for a browser application and I am having the same old problem deciding how to comment the code.

I'm trying to follow the JsDoc syntax, but will probably continue the Google Closure Compiler way. I may end up using two @return and @returns tags in the documentation, just for portability sake (when I setup the auto-generation of the documentation).

Now, the question, how do you document the return of a custom anonymous object from a function? For example:

JsDoc has an example of how a @param can be documented to expect object with certain fields, but not the @returns tag. Similarly, the Google Closure Compiler documentation of a Record Type is vague and has no example to work it out.

名前空間がモジュールの外部で定義されている jsdoc-toolkit を使用して、特定のモジュール パターン内の関数を文書化しようとしています。それに接続される関数は、即時呼び出し関数内にあります。ツールの出力から得られるものは次のとおりです。

警告: ドキュメント化されていないシンボル CORE のメンバーとして isObject をドキュメント化しようとしています。

コードの簡略版は次のとおりです。

モジュール化されたバックボーン アプリケーションを jsdoc3 を使用して文書化しようとしています。ただし、jsdoc を使用してこのコードを実行しようとすると、「キャッチされていない JavaScript スローからの例外: エラー: 依存関係がありません: Backbone.model」というエラーが表示されます。

「@extends Backbone.Model」を追加するとエラーが発生します。また、jsdoc3 を使用して、(require.js を使用する) バックボーン アプリをドキュメント化するための代替パターンに関する提案も歓迎します。

前もって感謝します。