JavaScript 注释文档 (JSDoc) : should @memberOf specify "prototype" as well?

Question

例子:

/**
 * @constructor
 * @Returns {AStar}
 */
function AStar() {


};

/**
 * @public
 *
 * Should this be:
 * @memberOf {AStar.prototype}
 * Or: 
 * @memberOf {AStar}
 *
 * @param {Number} startX
 * @param {Number} startY
 * @param {Number} destinationX
 * @param {Number} destinationY
 * @returns {Path}
 */
AStar.prototype.getPath = function(startX, startY, destinationX, destinationY) {
//(...)
};

对于上面截取的代码中添加到 AStar 原型(prototype)的函数“getPath”，“getPath”函数的注释文档是否应指定:

@memberOf {AStar.prototype}

或

@memberOf {AStar}

?

Answer 1

JavaScript 代码将getPath 声明为AStar 对象的方法。如果您不提供 @memberOf 标签，jsdoc 可以自行确定:文档将 getPath 列为 AStar 对象的方法.所以你不需要使用你在问题中引用的任何一个 @memberOf 选项。

此外，在您问题的特定情况下，jsdoc 不会使用您的@memberof 标记除非您使用带有感叹号@memberof 的表单! 。如果 jsdoc 认为它比你更了解该方法是什么成员，那么没有标记的表单可以被 jsdoc 忽略。带有感叹号的表单强制 jsdoc 不忽略它。因此，要对文档产生影响，您必须使用 @memberof!。