查询将函数写入 javascript 对象 JSDoc 属性

Question

我需要在 javascript 对象中放置一个函数，在这种情况下如何添加 JSDoc 注释？

/**
 * @typedef {Object} testObj
 * @property {!String} testName - testName
 * @property {?Function} [testFunction=null] - testFunction
 *
 */
var testObj = {
    testName:null,
    testFunction:null
}

在这种形式下，null是函数的默认值，所以这样表示。

我就想问一下，只写@property {?Function}，把参数写在Object部分就够了，还是有别的办法。

在上面的testFunction中，我想在JSDoc中显示一个参数为{Number} a, {number} b, {Object} c的函数。如果有办法，请告诉我，我将不胜感激。而且我还想表达一下这个函数 returns a String.

Answer 1

先使用@function定义函数，然后在任何需要的地方使用函数名，例如：

/**
 * A test function
 *
 * @function testFunction
 * @param  {number} a Number a
 * @param  {number} b Number b
 * @param  {Object} c Object c
 * @returns {string} Returns a string
 */

/**
 * A test Object
 *
 * @typedef {Object} testObj
 * @property {!string} testName The Test Name
 * @property {?testFunction} testFunction The Test Function
 */
const testObj = {
  testName: null,
  testFunction: null,
}

刚刚使用 jsdoc 对其进行了测试，并且使用 testFunction 属性.

中的 link 正确生成了文档

查询将函数写入 javascript 对象 JSDoc 属性

Inquiry to write function to javascript Object JSDoc property

javascript

jsdoc