JSDoc

Question

在 Javascript 中，我有两个名称相同但参数不同的函数。代码工作正常，但是当我尝试执行 jsdoc file.js 或 jsdoc2md file.js 时，出现 Identifier 'info' has already been declared.

错误

解决这个问题的方法是什么？

/**
 * Emits a log message with the added message. Level: 'info' (Same as log) 
 * @function
 * @param {String} message The message.
 */
async function info(message) {
  winstonLogger.log('info', message);
}

/**
 * Emits a log message with the added message and title. Level: 'info'
 * 
 * Example: Thu, 19 Nov 2020 13:08:54 GMT | title | message |
 * @function
 * @param {String} message The message.
 * @param {String} title A title that will appear in the first seaction as an event definer.
 */
async function info(message, title) {
  winstonLogger.log('info', message, {title});
}

Answer 1

虽然在技术上是有效的，但这个 Javascript 应该被认为是错误的，因为第二个 info 函数覆盖了第一个。这不是 jsdoc 或 jsdoc2md 的错误。

JSDoc - 标识符 'info' 已声明

JSDoc - Identifier 'info' has already been declared

node.js

jsdoc2md