部署Firebase Functions时遇JSDoc语法错误,指向注释首行/**
解决Firebase Functions部署时的JSDoc语法错误
以下是你代码中需要修复的几个问题:
代码块类型标记错误:你的代码使用了TypeScript的类型注解(如
IDType: number),但代码块标注为js,应该改为ts,这会让解析器正确识别代码类型,避免误判JSDoc语法。@returns语法不符合JSDoc规范:JSDoc中不能用
{number, string, string}来表示元组返回值,需要改为数组/元组的正确写法:@returns {[number, string, string]} 1/0(状态码), 错误信息, 目标字段内容可选优化:参数逗号格式统一:虽然不触发错误,但参数列表里把逗号放在参数前的写法不符合常规TS编码规范,建议调整为逗号后置,提升代码可读性。
修复后的完整代码示例:
/** * Gets any field value from a user's User collection. * @param {number} IDType 0 = uid, 1 = username. * @param {string} inputID the input ID, based on the IDType. * @param {string} desiredField the desired field value. * @returns {[number, string, string]} 1/0, error message, desired info. */ async function getUserInfo( IDType: number, inputID: string, desiredField: string ): Promise<[number, string, string]> { //... }
内容的提问来源于stack exchange,提问作者whatwhatwhat
相关产品推荐
相关产品推荐

