問題タブ [jsdoc3]

JSDoc3 を使用して AMD モジュールを文書化する方法を見つけようとしています。

残念ながら、http: //usejsdoc.org/howto-commonjs-modules.htmlにリストされているパターンはどれも私にはうまくいきません。

モジュールによってエクスポートされた関数のパラメーターと戻り値をリストする適切なドキュメントを生成するにはどうすればよいですか?

このファイルを考えると

JSDoc からドキュメントを取得できません。を作成しmodule-stuffutils.htmlますが、ファイルは基本的に空です。

/** @exports getStuff */関数ドキュメントで、定義の上、定義の下で試しました。@static、@alias、のさまざまな形式を試し@publicました。私が得ることができた最高のものは、明らかに私が探しているものではないグローバル関数として表示されることです。アイデア？

ドキュメントに従っているように見えるこれを試しました

しかし、それでも実際には機能しません。

ドキュメントが 2 回挿入されます。1 つではなく 2 つの関数が文書化されています。GetStuffCallback文書化されていません。getStuff他の関数が使用しているため、 の定義を移動できません。つまり、割り当てられたオブジェクトの匿名関数にしただけでは、exportsこのモジュール内から呼び出すことができません。私が意味することの例

上記で、関数が exports オブジェクトの匿名値にならない理由を理解していただければ幸いです。

という名前のクラスがFileDownloaderあり、それを文書化しようとしましたが、を使用して宣言されたプロパティとメソッドがprototype出力ファイルに生成されません。

タイトルの通り、jsdoc 3.3.0-alpha5を使用しています。

コードは次のとおりです。

生成されたドキュメントは次のとおりです。

何か案が？

jsdoc を使用してコールバックを適切に文書化するための最良の方法を探してインターネットを精査するのにかなりの時間を費やしましたが、残念ながら、まだ優れた方法を見つけていません。

これが私の質問です：

開発者向けの Node.js ライブラリを作成しています。このライブラリは、開発者が使用する複数のクラス、関数、およびメソッドを提供します。

私のコードを明確で理解しやすいものにするため、そして将来的にいくつかの API ドキュメントを (できれば) 自動生成するために、コードでjsdocを使用して何が起こっているかを自己文書化するようになりました。

次のような関数を定義するとします。

jsdoc を使用して、現在、この関数を次のように文書化しています。

コールバック関数が何を受け入れるかを絶対的に指定する方法がないため、上記のソリューションはちょっとハックっぽい気がします。

理想的には、次のようなことをしたいと思います:

上記は、コールバックが受け入れる必要があるものをより簡単に伝えることができるように思えます。それは理にかなっていますか？

私の質問は単純だと思います.jsdocでコールバック関数を明確に文書化する最良の方法は何ですか?

お時間をいただきありがとうございます。

私は善良な市民になり、ノードモジュールを文書化しようとしています....しかし、@typeに何を入れればよいかわかりません。私は webstorm を使用しているため、自動的に @type {exports} が配置されますが、そこに何を配置すればよいか少し混乱していますか?

誰か手を貸してくれませんか？これは私が開発している小さなモジュールで、問題をより強調するためにコードを削除しました。@type を使用する必要があり、エクスポートを文書化して適切な説明を必要とする方法について混乱しています。

@type {exports} は有効なタグですか??

誰もが良い基準を知っているか、そこに意見を述べます/彼らが何を使用するか/または何を使用しているか

Jsdoc はローカルにインストールされます ( npm install jsdoc )。 .\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js 出力 を実行しようとすると、次のエラーが発生します 。 DEBUG: JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT) DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknownTags":true},"templ ates":{"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles" :true}},"source":{"includePattern":".+\.js(doc)?$","excludePattern":"(^|\/|\\ )_"},"plugins":[]},"opts":{"_":["./lib/JavaScriptSource.js"],"debug":true,"destina tion":"./out/","encoding":"utf8"}}} There are no input files to process.

抽象的な注釈があることは知っているので、逆の注釈を期待していました。つまり、抽象メソッドを実装 (または拡張) するサブタイプのメソッドです。

JSDoc リファレンスには何も見つからないようです。