JSDoc:如何正确记录函数

时间:2017-07-21 01:27:38

标签: javascript jsdoc

我有一些问题需要了解JSDoc的正确用法。

这是一个简单函数的示例,我通过import { capitalizeFirstLetter, timestamp } from '/imports/module/functions.js'在我的项目中使用

在我的第一次尝试中,我创建了文档,函数只列在所有类和函数的巨大列表中。 所以我尝试使用@namespace,如下所示。但我不确定,如果这是正确的方法。

也许有人可以帮助我以正确的方式记录这个简单的例子。

/imports/module/functions.js

/**
 * @fileoverview  API: Functions
 * @namespace General Functions
 */

/**
 * Capitalize first letter of a string
 * @function
 * @memberOf General Functions
 * @param   {string}   string
 * @returns {string}
 */
const capitalizeFirstLetter = (string) => {
  return string ? string.charAt(0).toUpperCase() + string.slice(1) : ''
}

/**
 * Get current timestamp in miliseconds
 * @function
 * @memberOf General Functions
 */
const timestamp = () => {
  return Math.floor(Date.now() / 1000)
}

export {
  capitalizeFirstLetter,
  timestamp
}

0 个答案:

没有答案