WebStorm IDE
版本: Build #WS-192.6817.13 或者 2019.09.24構(gòu)建版本
代碼里經(jīng)常用到的注釋方式有以下幾種:
- 單行注釋:
// ......
- 塊注釋:
/* ...... */
- 文檔注釋:
/** ...... */
在不同的IDE
中鹿鳖,這些注釋的樣式有所差異扁眯,有的樣式比較醒目,能引起人的注意翅帜;有的則比較暗淡姻檀,盡量不分散寫代碼的注意力。如果有需要的話涝滴,絕大部分IDE
都能夠?qū)Ω鞣N注釋方式的樣式進(jìn)行自定義(如修改字體绣版、顏色、大小等)歼疮。請看下面的例子:
WebStorm特殊注釋標(biāo)記TODO杂抽、FIXME
WebStorm
中還有一些能幫助我們提高工作效率的注釋標(biāo)記,例如TODO
(大部分IDE
都有類似的特殊標(biāo)記)和FIXME
韩脏。先看看例子:
可以看到在雙斜杠之后添加
TODO
、FIXME
關(guān)鍵字都可以使注釋的樣式發(fā)生變化赡矢,這樣的特殊注釋可以跟一般的注釋區(qū)別開來杭朱,便于我們快速識別。當(dāng)TODO
吹散、FIXME
注釋行下方的連續(xù)注釋行存在縮進(jìn)時(tab
或空格
)弧械,屬于同一塊標(biāo)記注釋塊。(不僅雙斜杠注釋可以使用TODO
空民、FIXME
梦谜,其他類型的注釋快也可以使用)
WebStorm中的TODO面板
如果僅僅是以特殊的標(biāo)記方式,還不能很好的提高我們的工作效率袭景,WebStorm
還提供了專門的面板供我們索引項目中,或單文件中所有的特殊標(biāo)記闭树,通過點擊IDE
下方TODO標(biāo)簽
(Alt + 6
)打開該面板耸棒,如下圖:
-
TODO
面板標(biāo)簽按鈕入口 - 索引范圍:
-
Project
整個項目 -
CurrentFile
當(dāng)前文件 -
Scope Based
基于指定范圍(可以自定義范圍,這里不詳述)
-
- 索引列表报辱,可以單擊跳轉(zhuǎn)到對應(yīng)的注釋位置
WebStorm自定義TODO与殃、FIXME的樣式
依次點擊File
- Setting
(或Ctrl + Alt + S
),打開設(shè)置面板碍现,并在設(shè)置面板中搜索“TODO
”幅疼,見下圖:
- 搜索“
TODO
” - 搜索“
TODO
”后的結(jié)果 - 樣式欄,
WebStorm
通過樣式欄提供的正則表達(dá)式來查詢特殊標(biāo)記昼接,默認(rèn)會有todo
和fixme
的正則:\b(todo|fixme)\b.*
- 添加爽篷、刪除、編輯特殊標(biāo)記正則表達(dá)式
選中列表中的樣式慢睡,點擊編輯按鈕打開編輯面板逐工,編輯特殊標(biāo)記的樣式,見下圖:
- 修改正則表達(dá)式
- 選擇圖標(biāo)
- 是否為正則表達(dá)式中的字符開啟大小寫敏感
- 樣式編輯區(qū)域泪喊,勾選 ‘
Use color scheme TODO default colors
’后棕硫,使用的是全局主題中的默認(rèn)配色方案。如果要自定義樣式袒啼,先取消勾選哈扮。
點擊添加按鈕打開添加面板,跟上面的編輯面板雷同蚓再,可以添加自定義的特殊標(biāo)記正則表達(dá)式滑肉,如自定義正則:\b(freeman)\b:.*
,并使用自定義樣式对途,前景色選成藍(lán)色赦邻,見下圖:
添加完成后看看效果:
WebStorm中的TODO面板中的篩選功能
再次打開設(shè)置面板,并在設(shè)置面板中搜索“TODO
”实檀,查看上圖5
中惶洲,Filters欄目
:
點擊右側(cè)的添加按鈕并添加篩選過濾,打開添加面板膳犹,新增名稱為
@freeman
的篩選器恬吕,并勾選對應(yīng)的樣式,如下圖:- 篩選器名稱
- 篩選器對應(yīng)的特殊標(biāo)記
現(xiàn)在我們回到TODO
面板须床,使用我們剛剛添加的篩選器:
這樣就可以只看@freeman
的特殊注釋了铐料。
? WebStormw文檔參考地址