在 VSCode 中配置 JSDoc 注释行为 - 类似于 @deprecated 注释

在 VSCode 中配置 JSDoc 注释行为 - 类似于 @deprecated 注释

开箱即用的 VSCode 对 JSDoc 的支持非常好。

例如,如果我们使用@deprecated注释,那么该符号的引用将以删除线显示。

在此处输入图片描述

我遇到过一种情况,我想将某些函数标记为私有或受保护(请注意,我不是从面向对象封装的角度谈论的,我不是在做 OO)。也就是说,它们不一定被弃用 - 我只是想限制函数的调用位置 - 并给出视觉警告。

我认为@access private@private注释似乎适合这一点。

例如某些代码可能看起来像:



/**
 * @access private
 */
export function oldFunction() {

} 


/**
 * Developers should call this function, instead of calling oldFunction directly. 
 */
export function newFunction() {

    oldFunction(); 
}

答案不是采取诸如限制导出之类的措施oldFunction- 因为会有现有代码直接调用 oldFunction ,我想逐步整理它。

所以问题是 - 我非常希望 VSCode 能够将引用样式设置为oldFunction删除线或类似样式。有没有办法配置它?

答案1

这个问题的几个答案可以在这篇文章中找到
是否可以在 Visual Studio Code 中将文本切换为删除线文本?

这是已接受的 亚历克斯 (Alex) 的回答

您可以在 vscode 中借助以下方法 添加删除线TODO 突出显示 扩大:

"todohighlight.keywordsPattern": "(~~.+?~~)|(✔.+?\n)|(\\[x\\].+\n)",
"todohighlight.defaultStyle": {
    "color": "none",
    "backgroundColor": "none",
    "textDecoration": "line-through"
},

使用您通常使用的模式完毕todos。上面的方法适用于以下情况:

[x] done
✔ done
~~done~~

之后,您可以使用普通输入或者找到一些切换扩展,或者自己编写一个。

其他 谦虚地回答 建议使用 VSCode 出击。需要注意的是,在设置>扩展>Strike将避免-在空格之间插入字符。

相关内容