問題タブ [jsdoc3]

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 投票する
2 に答える
23593 参照

angularjs - AngularJS を使用した JSDoc

現在、私のプロジェクトでは JSDoc を使用しています。最近、Angular の実装を開始しました。すべてのドキュメントが同じ場所にあることを確認するために、引き続き JSDoc を使用したいと考えています。

私は主に ngDoc を使用するように言っているだけの人を調べましたが、これは実際には実行可能なオプションではありません。常に個別の JavaScript を使用し、理想的にはすべてを一緒に使用するためです。

現在、これは私が持っているものですが、run() のドキュメントを配置することはできませんか?

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

jsdoc - htmlでの出力例

次のような HTML を含む例を出力したいと考えています。

しかし、現時点ではHTMLとして「安全に」レンダリングしますが、テキストとして欲しいのですが、現時点では以下のように例を書く必要があります(実際のJSではもっと面倒で醜いです)

HTMLが自動的に「安全に」出力されるのを防ぐためにJSDocをソートする方法はありますか?

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

javascript - JSDoc の @param 型としての列挙型

次の例のように、JSDoc の@param型宣言に enum を使用することはできますか?

JavaScript 用の Eclipse などの IDE を使用する場合、警告は発生しませんか?

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

javascript - ソース コードから直接 JavaScript ドキュメントを生成する

それらの関数またはプロパティに関連付けられた適切にフォーマットされたコメント ブロックがない場合でも、JavaScript 関数およびプロパティのドキュメントを生成するツールを探しています (Doxygen のように)。

このJSDoc と他のドキュメント作成ツールとの比較では、JSDoc はコメント ブロック (前述の Doxygen など) がなくても、ソース コードを解析してドキュメントを生成できることが示されています。彼らは、他のすべてのツールはコメント ブロックを解析するだけだと言っています。

この指示に従って、npm (ノード上) から JSDoc 3.3.0-alpha4 をインストールし、プロジェクトのドキュメントを生成しようとしています。私が見る限り、JSDoc は、関連する JSDoc フラグを含む適切なコメントを持たない関数またはプロパティのドキュメントを生成しません。

JSDoc が何度も繰り返されてきたことは知っていますが、この機能は削除されたのでしょうか、それとも適切なスイッチを使用していないのでしょうか? コマンド ライン オプションを確認しようとしましたが、そのためのスイッチが見つかりませんでした。私は単に次のように使用しています:

smartcommentsなど、コードにドキュメント ブロックを自動的に追加できるツールが他にもあることは知っていますが、それはまさに私が探しているものではありません。誰かがそれに光を当てることができますか?

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

javascript - jsdoc の問題: ソース ファイルへのフル パスが表示される (意図しない)

プロジェクトに jsdoc3 を使用していますが、すべてがうまくコンパイルされます。

しかし、これは私が過去2日間いじっていて、あきらめました:(

MacOsX ターミナルからの最も基本的な呼び出しを使用して jsdoc を実行すると、生成されたドキュメント内のソース ファイルのフル パスが常に取得されます。

例:

生成されたインデックス ファイルでは、"index" を含む h1 と、その下に js ファイルへのフル パスを含む h2 が表示されます。

完全なローカルパスが表示されるのが好きではありません...
読んだ後、jsdocを実行した場所に関連すると思いました。
しかし、これはすべてまったく同じ結果になります。

としても

問題は、このパスが行番号参照およびソースコード ページでも使用されることです。そして、私の内部パスが表示されるのは本当にいいことではありません...

私が望む出力はprojectname/js/jsfile.js、または少なくとも単にjsfile.jsですが、私の人生ではこれを機能させることはできません。

誰かが私が間違っていることを教えてくれることを願っています。

よろしく、
ヤン