typescript 如何为我的VS代码扩展实现类似JSDoc的动态注解？

xfb7svmp 于 2022-12-05 发布在 TypeScript

关注(0)|答案(1)|浏览(164)

在VS代码中，在编写JavaScript代码时使用JSDoc注解非常方便，因为VS代码提供了非常有用的智能：

我想为我的VS代码扩展实现类似的东西，但到目前为止还不明白这是如何实现的。为了给我的语言扩展提供有用的智能感知，我写了一堆脚本来解析每个函数上面的头注解（在扩展构建期间），并将过滤后的数据添加到JSON文件中。然后，我使用这些JSON数据来提供智能感知（悬停提示、自动完成等）。
但是，此解决方案不是动态的，因为它不允许用户通过添加这些标头注解来提供自己的intellisense内容。要实现此目的，必须重新生成扩展。
那么，如何为我的语言扩展实现这种类似于JSDoc的注解特性呢？

typescript

来源：https://stackoverflow.com/questions/70895306/how-to-implement-jsdoc-like-dynamic-comments-for-my-vs-code-extension

1条答案

按热度按时间

ee7vknir1#

下面是一个如何操作的示例：

/**
 * Get a user's full name
 * @param  {Object}     user                        The user object
 * @param  {String}     user.firstName  The user's firstName
 * @param  {String}     user.lastName   The user's lastName
 * @return {String}                                     The user's fullname
 */
function getUserName (user) {
    let {firstName, lastName} = user;
    return `${firstName} ${lastName}`;
}

赞(0）回复(0）举报 2022-12-05

我来回答

typescript 如何为我的VS代码扩展实现类似JSDoc的动态注解？

1条答案

相关问题

热门标签

最新问答