WebStorm特殊注释标记(TODO、FIXME、自定义注释标记)

WebStorm IDE版本: Build #WS-192.6817.13 或者 2019.09.24构建版本

代码里经常用到的注释方式有以下几种:

  • 单行注释:// ......
  • 块注释:/* ...... */
  • 文档注释:/** ...... */

在不同的IDE中,这些注释的样式有所差异,有的样式比较醒目,能引起人的注意;有的则比较暗淡,尽量不分散写代码的注意力。如果有需要的话,绝大部分IDE都能够对各种注释方式的样式进行自定义(如修改字体、颜色、大小等)。请看下面的例子:

图1 LayaAir 2.x IDE的注释颜色

图2 WebStorm IDE的注释颜色(自定义后的颜色)

WebStorm特殊注释标记TODO、FIXME

WebStorm中还有一些能帮助我们提高工作效率的注释标记,例如TODO(大部分IDE都有类似的特殊标记)和FIXME。先看看例子:

图3 WebStorm中TODO、FIX注释标记

可以看到在双斜杠之后添加TODOFIXME关键字都可以使注释的样式发生变化,这样的特殊注释可以跟一般的注释区别开来,便于我们快速识别。当TODOFIXME注释行下方的连续注释行存在缩进时(tab空格),属于同一块标记注释块。(不仅双斜杠注释可以使用TODOFIXME,其他类型的注释快也可以使用)

WebStorm中的TODO面板

如果仅仅是以特殊的标记方式,还不能很好的提高我们的工作效率,WebStorm还提供了专门的面板供我们索引项目中,或单文件中所有的特殊标记,通过点击IDE下方TODO标签Alt + 6)打开该面板,如下图:

图4 WebStorm中的TODO面板

  1. TODO面板标签按钮入口
  2. 索引范围:
    • Project 整个项目
    • CurrentFile 当前文件
    • Scope Based 基于指定范围(可以自定义范围,这里不详述)
  3. 索引列表,可以单击跳转到对应的注释位置

WebStorm自定义TODO、FIXME的样式

依次点击File - Setting(或Ctrl + Alt + S),打开设置面板,并在设置面板中搜索“TODO”,见下图:

图5 在设置面板中搜索TODO

  1. 搜索“TODO
  2. 搜索“TODO”后的结果
  3. 样式栏,WebStorm通过样式栏提供的正则表达式来查询特殊标记,默认会有todofixme的正则:\b(todo|fixme)\b.*
  4. 添加、删除、编辑特殊标记正则表达式

选中列表中的样式,点击编辑按钮打开编辑面板,编辑特殊标记的样式,见下图:


图6 样式编辑面板
  1. 修改正则表达式
  2. 选择图标
  3. 是否为正则表达式中的字符开启大小写敏感
  4. 样式编辑区域,勾选 ‘Use color scheme TODO default colors’后,使用的是全局主题中的默认配色方案。如果要自定义样式,先取消勾选。

点击添加按钮打开添加面板,跟上面的编辑面板雷同,可以添加自定义的特殊标记正则表达式,如自定义正则:\b(freeman)\b:.*,并使用自定义样式,前景色选成蓝色,见下图:

图7 添加自定义样式

添加完成后看看效果:
图8 自定义特殊标记

图9 在TODO面板中的效果

WebStorm中的TODO面板中的筛选功能

再次打开设置面板,并在设置面板中搜索“TODO”,查看上图5中,Filters栏目

图10 筛选器

点击右侧的添加按钮并添加筛选过滤,打开添加面板,新增名称为@freeman的筛选器,并勾选对应的样式,如下图:
图11 添加筛选器

  1. 筛选器名称
  2. 筛选器对应的特殊标记

现在我们回到TODO面板,使用我们刚刚添加的筛选器:

图12 使用筛选器

这样就可以只看@freeman的特殊注释了。

​ WebStormw文档参考地址

WebStorm TODO comments

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容