問題タブ [jsdoc3]

i) 継承階層をテンプレートに実装できますか?

ii) 私が見たテンプレートでは、すべてのメソッドがアルファベット順にリストされていますが、ソース コードと同じ順序でリストできますか? (これは ES5 では特に必要ないことを理解していますが、ES 2015 が同様の OOP セマンティクスを持つ言語では、多かれ少なかれ標準だと思います。)

ES 2015 ドキュメントを実際に生成する JSDoc3 の初期の例として (そして私の要点を説明するために)、https ://bitbucket.org/gso/eonjs/src/ (「サポート」までスクロール) を参照してください。

シンプルな JS コード セットのドキュメントを作成しようとしています (以下を参照)。gulp を使用すると、期待どおりにドキュメントが作成されます。CLI を使用する場合、ドキュメントは不完全です。

これが私のJSコードです：

私のgulpファイル：

そして私のコマンドライン：

rawconf.json:

rawpackage.json:

Node.js コマンド プロンプトから gulp と jsdoc コマンドの両方を実行します。

gulp からの出力は、次のファイルです。

CLI からの出力は、次のファイルです。

jsdoc の gulp-jsoc バージョン (3.3.0-alpha5) と現在のバージョン (3.3.0-beta3) の間には、いくつかの小さな違いがあります。

しかし、最大の違いは、gulp 出力では に関する情報を見つけることができますが、CLI 出力のどこにtestFunctionも情報がまったく見つからないことです。testFunctionHTML コードも検索しましたが、何もありませんでした。

それで、私は何か間違ったことをしましたか？私はこの時点で同等性を達成しようとしているだけであり、オンラインで見つけることができるすべてのドキュメントを使い果たしました。

ある意味で配列のようなクラスがあります。

まず、次のようなドット表記でアクセスできる一般的な部分があります。

つまり、Array 型の一般的なプロパティがあり、次のように文書化されている可能性があります。

しかし、配列のように、特定の特定のメソッドがあります

loaddata は myclass のメンバーであり、文字列パラメーターを持ちます

既知のメンバーを持つクラスと、任意の名前を持つ可能性があるが常に特定の型であるいくつかのジェネリック プロパティを指定する方法がわかりません。

次のJavaScriptがあります。

これは、オブジェクト リテラルに名前空間化された関数を持つ RequireJS モジュールです。私が言及したのは: How do I JSDoc A Nested Object's Methods? JSDoc 表記をマークアップする方法を見つけるには。

grunt タスクで JSDocs 3.3.0-beta3 を実行しprivate: trueましたが、モジュール ページには publich メソッドのプライベート メソッドまたは引数がありません。

この JSDoc コードの出力は次のとおりです。

パラメータのドキュメントに JSDoc を使用しています。

のパラメータ型を文書化する方法は明らかですがmany_prompts、それが返す関数を文書化する正しい方法は何ですか?