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注釋標記
可以看到在雙斜杠之后添加
TODO
、FIXME
關鍵字都可以使注釋的樣式發生變化,這樣的特殊注釋可以跟一般的注釋區別開來,便于我們快速識別。當TODO
、FIXME
注釋行下方的連續注釋行存在縮進時(tab
或空格
),屬于同一塊標記注釋塊。(不僅雙斜杠注釋可以使用TODO
、FIXME
,其他類型的注釋快也可以使用)
WebStorm中的TODO面板
如果僅僅是以特殊的標記方式,還不能很好的提高我們的工作效率,WebStorm
還提供了專門的面板供我們索引項目中,或單文件中所有的特殊標記,通過點擊IDE
下方TODO標簽
(Alt + 6
)打開該面板,如下圖:
圖4 WebStorm中的TODO面板
-
TODO
面板標簽按鈕入口 - 索引范圍:
-
Project
整個項目 -
CurrentFile
當前文件 -
Scope Based
基于指定范圍(可以自定義范圍,這里不詳述)
-
- 索引列表,可以單擊跳轉到對應的注釋位置
WebStorm自定義TODO、FIXME的樣式
依次點擊File
- Setting
(或Ctrl + Alt + S
),打開設置面板,并在設置面板中搜索“TODO
”,見下圖:
圖5 在設置面板中搜索TODO
- 搜索“
TODO
” - 搜索“
TODO
”后的結果 - 樣式欄,
WebStorm
通過樣式欄提供的正則表達式來查詢特殊標記,默認會有todo
和fixme
的正則:\b(todo|fixme)\b.*
- 添加、刪除、編輯特殊標記正則表達式
選中列表中的樣式,點擊編輯按鈕打開編輯面板,編輯特殊標記的樣式,見下圖:
圖6 樣式編輯面板
- 修改正則表達式
- 選擇圖標
- 是否為正則表達式中的字符開啟大小寫敏感
- 樣式編輯區域,勾選 ‘
Use color scheme TODO default colors
’后,使用的是全局主題中的默認配色方案。如果要自定義樣式,先取消勾選。
點擊添加按鈕打開添加面板,跟上面的編輯面板雷同,可以添加自定義的特殊標記正則表達式,如自定義正則:\b(freeman)\b:.*
,并使用自定義樣式,前景色選成藍色,見下圖:
圖7 添加自定義樣式
添加完成后看看效果:
圖8 自定義特殊標記
圖9 在TODO面板中的效果
WebStorm中的TODO面板中的篩選功能
再次打開設置面板,并在設置面板中搜索“TODO
”,查看上圖5
中,Filters欄目
:
圖10 篩選器
點擊右側的添加按鈕并添加篩選過濾,打開添加面板,新增名稱為
@freeman
的篩選器,并勾選對應的樣式,如下圖:圖11 添加篩選器
- 篩選器名稱
- 篩選器對應的特殊標記
現在我們回到TODO
面板,使用我們剛剛添加的篩選器:
圖12 使用篩選器
這樣就可以只看@freeman
的特殊注釋了。
? WebStormw文檔參考地址