javascript - このコードを JSDoc3 で適切に文書化する方法

Question

このコードを JSDoc3 で適切に文書化する方法は?

var Foo,
    doFoo;

/**
 * What JSDoc string should go here ...
 */
doFoo = function () {};

/**
 * @constructor
 */
Foo = function () {};

/**
 * ... and here ..
 */
Foo.doFoo = doFoo;

/**
 * ... and here ..
 */
Foo.prototype.doBar = doFoo;

/**
 * ... and here?
 */
Foo.prototype.doBoo = doFoo;

助けていただければ幸いです..

Answer 1

おそらく探しているタグは@method( http://usejsdoc.org/tags-method.html ) です。これにより、パーサーは、関数のように見えないものが実際には関数であることを認識できます。

説明を複製したくない場合は、@link( http://usejsdoc.org/tags-link.html ) を使用して元の関数宣言の説明を指すこともできます。