Question

JSDoc 3的documentation包括这个例子：

/**
 * The complete Triforce, or one or more components of the Triforce.
 * @typedef {Object} WishGranter~Triforce
 * @property {boolean} hasCourage - Indicates whether the Courage component is present.
 * @property {boolean} hasPower - Indicates whether the Power component is present.
 * @property {boolean} hasWisdom - Indicates whether the Wisdom component is present.
 */

/**
 * A class for granting wishes, powered by the Triforce.
 * @class
 * @param {...WishGranter~Triforce} triforce - One to three {@link WishGranter~Triforce} objects
 * containing all three components of the Triforce.
 */
function WishGranter() {}

我实际上是在创建一个类，它接受一个实现接口MessageQueueConnector的对象，该接口应该实现一个方法connectAndSubscribe。由于Javascript不区分成员函数和成员变量，因此使用属性是有意义的，而JSDoc的文档暗示@method是无关的。然而，方法听起来更正确所以我想知道这是否是首选，或者我是否只是做了所有这些错误（即如果有一种更简单的方法来记录这种情况，而不是创建一个类型）。

Answer 1

@typedef的功能非常有限。您可以将方法定义为属性，但是您将无法以与在真实类中相同的方式记录参数。我为解决这个限制所做的就是作弊。我使用@class以便我可以按照我想要的方式记录它，并发出警告，表明它不是真正的类。所以：

/**
 * @classdesc Not a real class but an interface. Etc...
 *
 * @name MessageQueueConnector
 * @class
 */

/**
 * This method does...
 *
 * @method
 * @name MessageQueueConnector#connectAndSubscribe
 * @param {string} whatever Whatever this is.
 * @returns {Object} Description of return value.
 * @throws {SomeException} blah.
 */

请注意，上面的两个doclet不需要任何关联的JavaScript代码。您不需要在JavaScript中创建假类，也不需要创建假方法等。这就是您需要使用@name的原因。

我不喜欢告诉jsdoc这是一个类，然后放入文档中它不是，但我发现这是让jsdoc做我想做的最不令人反感的方法。我希望这种解决方法最终会随着jsdoc的发展而变得过时。

Answer 2

另一个选择是使用@typedef为每个方法定义一个回调。然后，在相关对象的@typedef中，使用@property标记定义每个方法，并提供回调名称路径作为属性类型。这些将在生成的文档中显示为成员而不是方法，但它们至少包含有关参数和返回值的信息。

Answer 3

我目前同时使用：

@tryAnyTag和
@property在课程注释中
- 由于只有方法注释具有名称路径（类注释中没有@property标签，所以我们将方法注释的名称路径插入到@property的描述中。）

示例：

/** @module Example */

/**
 * @class module:Example.Car
 * @property {Function} start {@link module:Example.Car#start}
 * @property {Function} stop {@link module:Example.Car#stop}
 *
 */
class Car {

    /**
    * @method module:Example.Car#start
    *
    */
    function start () { /* function body */ }

    /**
    * @description You could use various other tags here, 
    * and JSDoc will still auto-assign the following namepath 
    * "module:Example.Car#stop" to this method
    *
    */
    function stop () { /* function body */ }
}

不幸的是，文档编写者不得不承担双重责任，因为JSDoc编译器不会自动解决这一问题。在某个时候，应该只有一种方法可以一次完成所有操作-但这意味着破坏对JSDoc编译器的更改。

使用@method或@property的JSDoc对象方法？

3 个答案: