JSDoc标记可空返回值的正确语法是什么?
JSDoc 可空返回值写法说明
针对你给出的getTitle函数(返回值为字符串或null),几个选项的正确性如下:
- 第一种写法
@returns {?string}是正确的标准JSDoc语法:JSDoc里类型前加?前缀就表示该值可以是标注的类型,也可以是null,完全匹配你的函数返回场景。 - 第二种写法
@returns [string]是错误的:该写法在JSDoc规范里代表返回值是包含单个字符串元素的数组,和可空类型没有任何关联。 - 其他常用的正确写法:
目前更推荐可读性更高、同时兼容TypeScript类型检查的联合类型写法:@returns {string | null},这种写法表意更清晰,也是现在大多数前端项目的通用选择。
如果你允许返回值还可以是undefined,也可以用后缀?的写法:@returns {string?},等价于string | null | undefined。
内容的提问来源于stack exchange,提问作者robertwerner_sf
相关产品推荐
相关产品推荐

