作者热门文章
- html - 出于某种原因,IE8 对我的 Sass 文件中继承的 html5 CSS 不友好?
- JMeter 在响应断言中使用 span 标签的问题
- html - 在 :hover and :active? 上具有不同效果的 CSS 动画
- html - 相对于居中的 html 内容固定的 CSS 重复背景?
async function userInformation({ userId, token }) {
const body = {
user: userId
};
const headers = {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/x-www-form-urlencoded'
};
const url = 'https://example.com/api/users';
const data = await axios.post(url, headers, qs.stringify(body));
return data;
}
考虑这段代码我应该如何为此功能编写 jsdoc?如何确保参数类型在 jsdoc 中定义?
最佳答案
这并不完美,因为它是一个 open issue但你能做的最好的是:
/**
* @param {{ userId: number, token: string }} info
* @param {string} info.userId this description appears
* @param {number} info.token this also appears on hover
*/
async function userInformation({ userId, token }) {
const body = {
user: userId
};
const headers = {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/x-www-form-urlencoded'
};
const url = 'https://example.com/api/users';
const data = await axios.post(url, headers, qs.stringify(body));
return data;
}
你最终写了两次信息,但它似乎确保 VSCode 知道发生了什么。
关于javascript - 如何在 JSDoc 中记录解构参数?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/58410776/
我是一名优秀的程序员,十分优秀!