問題タブ [jsdoc]

私は個人的に生成されたドキュメンテーションの大ファンではありません (私はどちらかというと「ソース ルークを読む」タイプの人間です) が、そのようなドキュメンテーションが他の人にとってどのように役立つかは理解できます。さて、通常、ドキュメントの生成は、@method という 1 つのことを除いて、私には影響しません。

ほとんどの JSDoc 注釈 (例: @param) は、ソースを読んでいる人には依然として完全に役立ちますが、@method100% 冗長です。

そのため、何百行もコードが乱雑になるのは避けたいと思ってい@methodます。しかし、私の同僚は@method、JSDoc ジェネレーター (彼は YUI ジェネレーターを使用しています) がクラスのメソッド リストを生成できるようにするために必要だと考えています。

それで、私の質問 (そこにいる JSDoc の専門家への) は次のとおりです: 有用なドキュメントを生成する方法はありますか (つまり、リストされているクラスのメソッドを使用) @method。または、@method本当に必要な場合、関数名からメソッド名を推測できるJSDocジェネレーターはあり@methodます@method addFiveか?

PS質問に直接答えるのではなく、問題を完全に回避する方法を提案する「あなたは間違っている」タイプの回答がある場合は、ぜひ聞きたいです。私は確かに JSDoc の専門家ではありません。

プロジェクトで使用できるJSDocパーサーを探しています。JSDocコメントを渡して、そのコメントの意味について構造化された説明を受け取ることができるものを探しています。私が見たツールのほとんどは、JSDocコメントをHTMLまたはその他の形式に変換できるようです。他のツールにフィードするために使用できるコメントの中間表現を提供するものを探しています。

使用できるツールやライブラリはありますか？

JSDocにはさまざまなフレーバーがあることを私は知っています。また、JSDocパーサーの各実装は、独自のタグのセットを認識しているようです。たとえば、 http： //usejsdoc.org/とhttp://www.techrepublic.com/blog/programming-and-development/create-useful-relevant-javascript-documentation-with-jsdoc/のタグの違いについて考えてみます。 451。

この時点で、私はただ混乱しています。JSDocまたは広く認識されているコアタグのセットの正規の実装はありますか？JSDocの最良の実装はありますか？

編集

以下のコメントで尋ねられているように、この質問の理由は、私たちが作成しているツールで使用するためにJSDocコメントを解析する必要があるためです。この質問を参照してください」：Javascriptで記述されたオープンソースのJSDocパーサーはありますか？

自分のパーサーをロールする必要があるのではないかと心配しています。ロールする場合は、サポートする必要のあるタグを知る必要があります。

しかし、より深いレベルでは、一貫した仕様（またはリファレンス実装）がないことが懸念されます。これにより、JSDocは私にとって少しアドホックな感じになります。

関数ジェネレーターを文書化しようとしていますが、成功していません。これは例です:

JSDoc (および IntelliJ) で sayHello を適切に解決するには、genericObjectGenerator とその specificObject 関数をどのように文書化する必要がありますか。

私のクラスの1つは、goog.Disposableを拡張しているため、jsDocエラーを生成します。@extendsを使用してこれを指定していますが、まだ機能していません。クロージャーリンターを使用すると、ファイルはエラーなしでコンパイルされます。コードはここにあります」

を拡張するモジュールを宣言する場合dojo/Stateful、getter と setter のパターンは定義され_xxxGetter、and_xxxSetterとして明示され.get('xxx')ます.set('xxx')。

それで、私の質問は、これを JSDoc でどのように文書化するのが最善ですか? @function代替メソッド名の提供をサポートしていないようですが、とにかく、これはメソッド名ではなくパラメーター値のバリエーションですか?

では、JSDoc はこのモデルを固有にサポートしていますか? それとも、このようなものについて明示的なドキュメントを書く必要があるだけですか?

JavaScriptシングルトンを次のように定義しています。

詳細モード（-v）では警告は出力されませんが、ドキュメントには「com.mydomain.ClassName（）」のみが報告され、説明として「Adescriptionhere」が含まれています...ClassNameのメソッドのドキュメントも生成するにはどうすればよいですか？

を介していくつかのインスタンス プロパティを定義するクラスがあり、JSDoc 3にそれらがクラスに属していることを認識させるのObject.definePropertiesが非常に困難です。

ここに私が取り組んでいるものの簡略化されたバージョンがあります:

JSDoc を実行すると、 、 、 、および の出力が得られますがmymodule、Exampleはfoo得られbarませんfoobar。@memberofのタグを削除するfoobarと、グローバルとして登録されます。呼び出しとそれに渡されたオブジェクトの両方@memberof mymmodule~Exampleに追加し、それを に変換しようとしましたが、結果は変わりません。@lendsObject.definePropertiesObject.defineProperty

foobarに属していると文書化するにはどうすればよいExampleですか?

問題1731が発生し、Googleスクリプトエディタ内でjsdocのプレビューを要求していることを知っています。http://code.google.com/p/google-apps-script-issues/issues/detail?id=1731

それが実装されるのを待つ間、新しいバージョンを作成する必要なしに、公開されたライブラリに追加しているjsdocコメントをプレビューするための最良の方法は何ですか？

nodejsでwebstormideを使用しています。モジュールを作成して必要な場合、コードを完成させることはできません。

例えば：

test.js

main.js

jsdoc3のドキュメントでモジュールの使用法についてはまだ何も見つかりませんでした。：S