問題タブ [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.
javascript - JSDOC でオブジェクトの配列を文書化する方法
オブジェクトの配列をパラメーターとして持つ関数があり、次の例のように JSDOC を使用してパラメーター (配列内のオブジェクトのプロパティを含む) を記述したいと考えています。
フィルターは次のようなものです。
idプロパティとvaluejsdoc3をどのように文書化しますか?
jsdoc3 - モジュールパターンを明らかにするJsdoc名前空間
名前空間を明らかにするモジュールパターンで動作させようとしています。次のようなコードがあります。
ただし、JSdoc は getDataSeller のドキュメントを取得していません。誰かがこれを行う方法と、上記が機能しない理由を教えてくれれば、それは素晴らしいことです。
jsdoc - ノードを含むjsdocは空のindex.htmlを生成します
次のコマンドを使用して、javascript ファイルから html を生成しました。
コマンドの出力
jsdoc - jsdoc を使用してドキュメントを生成する際に、メニュー セクションにサブメニューを自動生成する方法
Jsdoc を使用してドキュメントを生成するときに、このようなサブメニューを自動生成したいと考えています。そうすることは可能ですか？はいの場合は、それが行われた方法を教えてください。サブメニュー付きのサンプル ドキュメント
（編集済み）（ ReadTheDocs）を使用してドキュメントを作成する簡単な方法を得ました
javascript - JavaScriptモジュールで列挙型をエクスポートするための正規のパターンは何ですか?
require と jsdoc を使用して JavaScript モジュールから列挙型をエクスポートするための正規のパターンを知りたいです。既存の例と質問は、ローカルのプライベート列挙型のみを考慮しているようです。私の目標は、可能な限り最高品質のドキュメントとインテリセンス/コード補完を用意することです。
これが私の現在の最善の試みです：
このアプローチに私を導いたいくつかの詳細があります：
- 高さは列挙型です。静的です。
- Object.freeze がベスト プラクティスのようです。
- LawnMower.heights = Object.freeze(...) を実行すると、Visual Studio のインテリセンスが機能しなくなります。したがって、私は2つのステップでそれを行います。
- @readonly を追加しましたが、何もしないと思います
- mow() 関数は LawnMower.height を参照しますが、どのツールもそれをあまり処理していないようです。
私たちのチームは、Visual Studio、Ace+Tern、および Atom を使用しています。上記のパターンで、次のようなコードを書くと:
インテリセンスがパラメーター名、型、および説明を表示することを期待しています。「LawnMower.heights」を記入するとボーナスポイント。私たちのために。(Visual Studio は C# に対してこれを行います)。
結果：
- Atom はここで @param を完全に無視しているようです。
- Visual Studio は、引数が高さであることを通知しますが、型や説明は提供しません。
- Ace/Tern は高さの @jsdoc コメント行を表示します。
具体的な質問: @param 行を正しく書きましたか? 名前パス「LawnMower.heights」は、LawnMower の静的メンバーを参照する正しい方法だと思います。
参考文献:
javascript - ネストされたモジュール クラスに JSDoc3 でコメントを付ける
コメントしようとしている WebStorm のライブ検査でモジュール パターンを扱っています。
そして、AMD/CJS は使いたくありません。
「MyAnotherClass」に同じタイプのコメントがあるとします。私の問題は、これを試しているときです: var test = new MyAnotherClass(s);WebStorm は、メソッド式が関数型ではないことを教えてくれます。
私に何ができる ？
さらに情報が必要な場合は教えてください。私の下手な英語で申し訳ありません.
L.
編集: param 定義で最初のコメント ブロックを削除すると問題が解決するようですが、それが最善の方法だとは思いません。
EDIT2:抽象クラスのプロパティに関する同じ問題
javascript - jsdoc socket.on('event', function() {}) とルート ハンドラを文書化する適切な方法
次の形式の jsdoc を使用して API を文書化する方法 (単一ファイル)
私の唯一のアイデアは、@namespace上記のエクスポートと@lends上記の匿名関数を追加することですが、その結果、空のドキュメントが作成されます。