js 文档注释规范

参考

Airbnb JavaScript Style Guide (中文译版)

Airbnb JavaScript Style Guide (原版)

一份可参考的系列文章：

前端规范之 JS 代码规范（ESLint + Prettier）

前端规范之 CSS 规范（Stylelint）

前端规范之 Git 提交规范（Commitizen）

前端规范之 Gti 工作流规范（Husky + Commitlint + Lint-staged）

规范 JavaScript 注释

示例

/**
 * descriptions
 *
 * @name _
 * @constructor
 * @category Seq
 * @private @static
 * @memberOf _
 * @since 0.1.0
 * @param {number} Object/Array/Function/boolean/number/string/* value
 * @returns {object}
 * @see _.assign
 * @example
 */
function func() {}