問題タブ [jsdoc3]

jsdoc ( http://usejsdoc.org/ ) を使用して JavaScript ドキュメントを生成しようとしていますが、うまくいきません。私のコメントはすべて無視されています。生成された html にすべてのコメントを表示するにはどうすればよいですか?

ターミナルで、次のコマンドを実行します。

私の sample.js ファイルは次のようになります。

jsdoc の conf.json は次のようになります。

ES6 テンプレート文字列を許容するように jsdoc 3.3.3 を構成する方法はありますか? おそらく、動作する可能性のあるプラグインはありますか？

node.js プロジェクトの json スキーマがたくさんあります。次の目的でそれらを使用できますか?

• 「.js」コード ファイルから jsdoc タイプとしてアクセスして、Webstorm の IntelliSense の精度を高める
• または、jsdoc タイプ定義を自動的に作成する場合

?

コードを文書化する最良の方法を探していますが、何も見つかりません。

thisを含む他のトピックを見てきましたが、すべてが私の問題を解決するわけではありません。

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

製品クラスと製品クラスがモデル/製品モジュールに表示される、読みやすいドキュメントを生成する必要がありますが、モジュールを明確にし、クラスを別々に取得します。

この問題を経験した人がいると思います。

ありがとう。

PD1: 私は本当に他の投稿を読んでいます。質問を重複させようとしているわけではありません。

PD2: 下手な英語ですみません:S

次のディレクトリ構造を持つノード モジュールsomething-niftyを開発している場合:

また、plugin.csは次のように定義されています。

生成されたドキュメントでは、クラスは@innerタグを持っているかのようにドキュメント化されています。これは、参照するたびにクラス名を 2 回繰り返す必要があることを意味します。

モジュールは本質的にクラスであるため、この状況でクラス名を 2 回指定する必要はありません。適切に構造化されたドキュメント (モジュールとクラスのリスト) を出力するように、これに jsdoc3 タグで注釈を付ける正しい方法は何ですか?

JSDoc によって文書化されたすべてのメンバー/オブジェクト/などは、独自のクリック可能なリンクにする必要があると思います。たとえば、 がある場合levelOne --> levelTwo --> levelThree --> levelFour、最初のページに levelOne が表示され、クリックして levelFour に進むことができるはずですが、そうではないようです。

これが私のコードです：

「名前空間」オブジェクトは簡単にクリック可能で、ホームページからアクセスできますが、クリックできPluginTests ません (リンクではありません!!) ためtest1、innertest1アクセスできません。JSDoc の仕組みをひどく誤解していますか?

PS: 誰かが私のコードを傷つけるコメントで引き裂き始める前に、私が JSDoc の存在を知ったのは約 3 時間前であり、これに非常に慣れていないことに注意してください。

angular アプリケーションのドキュメントを追加することを検討していますが、これまでの調査結果から、JSDoc が一般的な選択肢のようです。

私は現在、モジュールと関連するコントローラー\ディレクティブ\サービス\などに続く構造で生成するドキュメントを取得するのに苦労しています。

最初に、私が取り組んでいるアプリケーションにある種類のコードのサンプルを次に示します。

そこで、CustomersListController で定義された関数をカバーするドキュメントを書きたいと思います。

リレーションシップを定義する方法を示す受け入れられた回答でこの投稿を見たので、次のようにコードでこれを使用しようとしました:

私はgulp-documentationを使用しており、次のようにタスクを設定しています。

実行すると、次の出力が生成されます

左側のナビゲーションに正しい階層を表示するという点で、より読みやすいものを望んでいたため、app.features が 2 番目のレベルに、app.customers が 3 番目のディレクトリ スタイルに表示されます。

また、「モジュール」も出力にリストされていることに気付きましたが、それがどのように生成されたのかわかりません。上記で共有したコードのモジュールの 1 つにモジュール宣言とコントローラー宣言がありますが、JSDoc はどこからこれを取得するのでしょうか?

JSDoc 構文を使用して、Angular アプリケーションで宣言されたモジュールとそれに関連するクラス (コントローラー、サービス、ディレクティブなど) の間の関係を定義し、生成された出力で簡単にナビゲーションできるようにネストされたビューに表示する正しい方法は何ですか?

編集

ngdocs とgulp-ngdocsプラグインにも出くわしましたが、まだ多くの問題が未解決で、あまり活発なレポではないようです。このプラグインとその適合性についてコメントを提供できますか? サンプルのgrunt-docsバージョンをダウンロードして実行しましたが、これは十分に機能しているように見えますが、親の 'rfx' モジュールをクリックしてもページの読み込みに失敗します (ブラウザー コンソールに 404 が表示されます) - 正直に言うと、少し緊張します!

私は角度のあるアプリケーションに grunt-ngdocs を使用して把握し始めたばかりで、これまでのところうまくいっています。

しかし、コントローラーの 1 つで別の文書化されたプロパティのいくつかのプロパティを文書化したいと思います。

次のコードを検討してください。

ご覧のとおり、いくつかのプロパティが vm 変数からぶら下がっています。これらは通常、コントローラーで定義された関数への参照です。

上記の ngdocs\jsdocs ドキュメント構文を使用すると、vm プロパティをドキュメント フォルダに出力できますが、vm オブジェクト自体のプロパティをドキュメント化する方法がわかりません。

これを行うための賢明な、または推奨される方法はありますか? vm を完全に文書化せず、それぞれの vm.xxx を個別に文書化することについて疑問に思いましたが、これについてはよくわかりません!

ありがとう