私は個人的に生成されたドキュメンテーションの大ファンではありません (私はどちらかというと「ソース ルークを読む」タイプの人間です) が、そのようなドキュメンテーションが他の人にとってどのように役立つかは理解できます。さて、通常、ドキュメントの生成は、@method という 1 つのことを除いて、私には影響しません。
ほとんどの JSDoc 注釈 (例: @param
) は、ソースを読んでいる人には依然として完全に役立ちますが、@method
100% 冗長です。
/*
* @param num number to add five to
* @method addFive
*/
function addFive(num) { ...
そのため、何百行もコードが乱雑になるのは避けたいと思ってい@method
ます。しかし、私の同僚は@method
、JSDoc ジェネレーター (彼は YUI ジェネレーターを使用しています) がクラスのメソッド リストを生成できるようにするために必要だと考えています。
それで、私の質問 (そこにいる JSDoc の専門家への) は次のとおりです: 有用なドキュメントを生成する方法はありますか (つまり、リストされているクラスのメソッドを使用) @method
。または、@method
本当に必要な場合、関数名からメソッド名を推測できるJSDocジェネレーターはあり@method
ます@method addFive
か?
PS質問に直接答えるのではなく、問題を完全に回避する方法を提案する「あなたは間違っている」タイプの回答がある場合は、ぜひ聞きたいです。私は確かに JSDoc の専門家ではありません。