我尝试在函数的描述中引用参数,如下所示:
/**
* Deletes the Travel Cost with the given {@param id}
* @param id the id of the travel cost to be deleted
*/
deleteTravelCost(id: number): Observable<{}> { [...] }
但它似乎不适用于{@param id}
。调用该函数时的结果如下:
(method) TravelCostsService.deleteTravelCost(id: number): Observable<{}>
Deletes the Travel Cost with the given {@param id}
@param id — the id of the travel cost to be deleted
我希望在文档中有一个可点击的元素引用参数(在函数的一般描述中,而不是在实际的参数描述中)。有没有合适的方法在描述中引用参数甚至函数的返回值?(我使用Visual Studio Code)。
3条答案
按热度按时间pqwbnv8z1#
有没有一种方法可以正确引用参数
不能交叉引用参数:https://github.com/jsdoc/jsdoc/issues/1145#issue-126426000
返回描述中的函数
同样,你不能引用它。但是你可以记录它with returns,例如:
roejwanj2#
正如@basarat所说,没有办法在文档本身中交叉引用参数,所以我能想到的最接近的方法是@link和@see指令
0g0grzrc3#
2023年4月,VSCode v1.73.1
{@link paramname}
将在VSCode的注解弹出窗口中显示为链接,单击它将指向引用的参数。@returns
标记包含@link
参数引用的示例:VSCode文档弹出窗口如下所示: