問題タブ [jsdoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
1 に答える
2369 参照

pdf - JsDoc から PDF へのレンダラー

JsDoc を PDF に変換するツールを知っている人はいますか? それとも、HTML ファイルを PDF に変換する必要がありますか? ご回答ありがとうございます !

0 投票する
2 に答える
2148 参照

javascript - すでに文書化されているメソッドを jsdoc-toolkit に含める方法は?

クロージャ メソッドで作成された JavaScript シングルトン オブジェクトがあります。

しかし、jsdoc-toolkit_fooは、メソッドからメソッドへの継承されたドキュメントを生成しませんfoo

@seeそれが機能する代わりに書いた場合@borrows(正しいメソッドへのリンクを挿入します)、メソッドのドキュメントをコピーして貼り付けて、公開ドキュメントも作成したくありませんfoo

0 投票する
3 に答える
10024 参照

javascript - jQueryがJSDocを使用しないのはなぜですか?

それとも、それらはソースに含まれていませんか?jQueryを解析するたびにjs-doc-toolkitがおかしくなるのを防ぐ何かを本当に手に入れたいです。また、jQueryの構造を適切に文書化できない定型的なjs-docブロックを少なくとも配置しないと、依存関係としてjQueryを使用してコードを適切に文書化できないことも意味します。私が知らない一般的な解決策はありますか?ところで、グーグルを試してみました。

0 投票する
3 に答える
6052 参照

javascript - IntelliJIDEAでのJSDocサポート

2つのIntelliJがサポートするJSDocサブセット、スーパーセット、またはそれらの組み合わせに関するドキュメントはありますか?JSDocを使用する動機は2つあります。

  1. 開発者向け:IntelliJは、より優れたコード補完、コードチェック、エラーチェックなどを提供できます。
  2. 実行時の効率のために:Closureコンパイラを使用します。

上記の#1では、IntelliJでサポートされているJSDocマークアップを使用することが重要です。これまで、これを理解することは、ほとんど試行錯誤のプロセスでした。

0 投票する
4 に答える
2571 参照

javascript - Google ClosureCompilerは100%入力されました

Googleクロージャコンパイラに関してアプリケーションを100%入力するにはどうすればよいですか?

私はすでにすべてをjsdocコメントでタグ付けしました。100を取得することさえ可能ですか?私は64,6%です

0 投票する
5 に答える
8849 参照

javascript - jQuery互換のJavaScriptドキュメントジェネレータ

(jquery、アンダースコア、バックボーンで構築された)javascriptプロジェクト用のドキュメントジェネレーター(javaのjdocまたはrubyのrdocに類似)を選択する必要があります

候補者:

要件

  • jquery、アンダースコア、バックボーンで動作するはずです。つまり、オブジェクトリテラルメソッドなどです。
  • 私はpdocが本当に好きですが、プロトタイプが中心であり、文書化が不十分であり、それを機能させるために余分なファイル(セクション?)を作成したくありません(これについてはわかりません)
  • doccoは素晴らしいですが、構造化された出力が必要です(jdocのようなメニュー+クラス/関数構造のように)
  • コマンドライン/makefile互換である必要があります(Webパスティではありません)

ヒント、トリック、チュートリアル、サクセスストーリー、アドバイスは大歓迎です。


jQueryがJSDocを使用しないのはなぜですか?

0 投票する
1 に答える
294 参照

javascript - Google が JS API ドキュメントに使用しているドキュメント標準は何ですか?

一見、JSDoc または jsdoc-toolkit のように見えますが、どちらにも定義されていないタグがあります。JSDocを使用しているGoogle JavaScript Style Guideを読みましたが、公開ソースコードにはJSDoc以外のタグがたくさんあるので、興味があります。

0 投票する
4 に答える
29644 参照

javascript - JSDocでオープンエンドの引数関数を文書化する正しい方法

次のようなものがあるとしましょう。

この関数がJSDocで任意の数の引数を取ることができることをどのように正しく文書化しますか?これは私の最善の推測ですが、それが正しいかどうかはわかりません。

関連:php-可変数のパラメーターをドキュメント化する方法

0 投票する
5 に答える
46883 参照

javascript - JsDocでvoidを返す方法は?

JsDocでvoidを返すメソッドまたは関数を宣言する特定の方法はありますか?現在、私はvoidデフォルトの戻り値であると信じており、他の戻り値を具体的に提供する必要があります。

0 投票する
2 に答える
6020 参照

javascript - JsDoc の多重継承または mixins の方法は?

ミックスインまたは多重継承を文書化するにはどうすればよいですか?

JsDocの公式なものはありますか? そうでない場合、どのように書くのが望ましいですか?