問題タブ [jsdoc]

jsdoc を使用してネストされた配列とオブジェクトをフォーマットするにはどうすればよいですか?

これは私の最善の推測です：

オブジェクトがある種の文字列によってインデックス付けされていることを示すにはどうすればよいですか?

ネストされた配列を定義するにはどうすればよいですか?

また、オプションのパラメーターで角括弧をどこに置くべきかわかりません。

問題は、Komodo intelli-sense がこのように定義されたオブジェクト メソッドを認識しないことです。

「アプリ」と入力します。結果は得られません。

ただし、以下のようにオブジェクトを定義すると問題なく動作します。

最初のパターン例でオートコンプリートを機能させる方法は?

クロージャ内で bar と呼ばれるこのプライベート関数にどのように注釈を付けますか?

そのようです？

それともそうですか？

それとも、両方のドキュメントの組み合わせですか? しかし、関数のパラメーターと戻り値の型の情報が重複していると思います。

クロージャーの例全体の完全な jsDoc の例。「プライベート」関数用の @private jsDoc はもうありません (「ジョン」が言ったように)。

JavaScriptClosureCompilerで使用されるJavaScriptを文書化するためのJSDocスタイルを理解しようとしています。私は以下のJavaScriptコードを持っています

このコードで高度なコンパイルを実行すると、2つの警告が表示されます。

この関数appendは、カプセル化オブジェクトへの服従を返します。返される変数、、SingletonStringBufferが宣言されているので、何が間違っているのか、どのように修正するのかわかりません。

私は2種類のモジュールを持っています：

Require.jsメインファイル：

メディエーターパターン：

jsdocでも可能であれば、jsdoc3でこれを文書化するにはどうすればよいですか？

私は現在、私たちが持っているいくつかのJavascriptコードをリファクタリングしており、とりわけ、明らかにするモジュールパターンを利用するようにコードを変更しました。コードはかなりきれいに見え、正常に動作しますが、アウトラインビューに関数が表示されなくなりました。トップレベルの名前空間varをvarとして表示しますが、展開して内部の関数を表示することはできません。

以前は次のようになっていたコードを考えてみましょう。

この場合、アウトラインビューに両方の機能が表示されます。しかし、これに変更すると：

次に、アウトラインビューにmyNamespace変数が表示されます。探してみましたが、実際に階層を正しく表示するビューが見つかりません。誰かがこれを見る方法を知っていますか、それとも日食がこれを行うことができない場合ですか？

API には、JSONPath でオブジェクトを検索できる単純なメソッドがあります。その構文は初心者の開発者にはほとんどなじみがないため、JSDoc コメント内でいくつかの例を提供することにしました。ただし、ここに問題があります。 -@記号は新しい jsdoc-tag の開始として扱われるため、記述が破損します。

質問: NetBeans (または一般的には jsdoc)が特定のコード チャンク内の記号を無視するようにするにはどうすればよいですか? @好ましくは、@exampleブロック内。

したがって、このコードは、ツールチップ内で変更されていないことを示します。

$..book[?(@.price<10)] // - filter all books cheaper than 10

また@example、、、<code>-<pre>役に立ちません。

Html エンティティはツールチップに@変換されますが、コード自体 ( ) では判読できず、メインの jsdoc テキストでのみ機能します...@$..book[?(&#64;.price<10)]

プロジェクトの文書化に jsdoc ツールキットを使用していますが、別のプライベート オブジェクト内のプライベート オブジェクトを文書化する問題の中にいます。

私はこの警告を受けました：

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

しかし、testObject はドキュメントの出力に「 {Object} testObject 」として適切に表示されます。

以下は JavaScript ファイルのテストです。

@paramタグを使用すると、プロパティのドキュメント化が可能になります。

@thisタグのプロパティをどのように文書化しますか？

プロジェクトに取り組んでいる人が知っているかどうか疑問に思います。（ドキュメントはまだ作成中です...）